The key that uniquely identifies the report file in\n\t\t\tyour S3 bucket.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#CreateCertificateAuthorityRequest": { @@ -1921,7 +1927,7 @@ "KeyStorageSecurityStandard": { "target": "com.amazonaws.acmpca#KeyStorageSecurityStandard", "traits": { - "smithy.api#documentation": "Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.
\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER
\n\n Note:\n FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in the following\n\t\t\tRegions:
ap-northeast-3
\nap-southeast-3
\nWhen creating a CA in these Regions, you must provide\n\t\t\t\tFIPS_140_2_LEVEL_2_OR_HIGHER as the argument for\n\t\t\t\tKeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\tInvalidArgsException with the message, \"A certificate authority cannot\n\t\t\tbe created in this region with the specified security standard.\"
Specifies a cryptographic key management compliance standard used for handling CA\n\t\t\tkeys.
\nDefault: FIPS_140_2_LEVEL_3_OR_HIGHER
\nSome Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you\n\t\t\t\tmust provide FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for\n\t\t\t\t\tKeyStorageSecurityStandard. Failure to do this results in an\n\t\t\t\t\tInvalidArgsException with the message, \"A certificate authority\n\t\t\t\tcannot be created in this region with the specified security standard.\"
For information about security standard support in various Regions, see Storage\n\t\t\t\t\tand security compliance of Amazon Web Services Private CA private keys.
\nSpecifies whether the CA issues general-purpose certificates that typically require a\n\t\t\trevocation mechanism, or short-lived certificates that may optionally omit revocation\n\t\t\tbecause they expire quickly. Short-lived certificate validity is limited to seven\n\t\t\tdays.
\nThe default value is GENERAL_PURPOSE.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#CreateCertificateAuthorityResponse": { @@ -1947,6 +1956,9 @@ "smithy.api#documentation": "If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This\n\t\t\tis of the form:
\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\n .\n\t\t
The number of days to make a CA restorable after it has been deleted. This can be\n\t\t\tanywhere from 7 to 30 days, with 30 being the default.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#DeletePermission": { @@ -2263,6 +2281,9 @@ "smithy.api#documentation": "The Amazon Web Services account that calls this action.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#DeletePolicy": { @@ -2307,6 +2328,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#DescribeCertificateAuthority": { @@ -2397,6 +2421,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityAuditReportResponse": { @@ -2426,6 +2453,9 @@ "smithy.api#documentation": "The date and time at which the report was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityRequest": { @@ -2438,6 +2468,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#DescribeCertificateAuthorityResponse": { @@ -2449,6 +2482,9 @@ "smithy.api#documentation": "A CertificateAuthority structure that contains information about your private\n\t\t\tCA.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#EdiPartyName": { @@ -2768,6 +2804,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#GetCertificateAuthorityCertificateResponse": { @@ -2785,6 +2824,9 @@ "smithy.api#documentation": "Base64-encoded certificate chain that includes any intermediate certificates and\n\t\t\tchains up to root certificate that you used to sign your private CA certificate. The\n\t\t\tchain does not include your private CA certificate. If this is a root CA, the value will\n\t\t\tbe null.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#GetCertificateAuthorityCsr": { @@ -2846,6 +2888,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#GetCertificateAuthorityCsrResponse": { @@ -2857,6 +2902,9 @@ "smithy.api#documentation": "The base64 PEM-encoded certificate signing request (CSR) for your private CA\n\t\t\tcertificate.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#GetCertificateRequest": { @@ -2876,6 +2924,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#GetCertificateResponse": { @@ -2893,6 +2944,9 @@ "smithy.api#documentation": "The base64 PEM-encoded certificate chain that chains up to the root CA certificate\n\t\t\tthat you used to sign your private CA certificate.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#GetPolicy": { @@ -2931,6 +2985,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#GetPolicyResponse": { @@ -2942,6 +2999,9 @@ "smithy.api#documentation": "The policy attached to the private CA as a JSON document.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#IdempotencyToken": { @@ -3018,6 +3078,9 @@ "smithy.api#documentation": "A PEM-encoded file that contains all of your certificates, other than the certificate\n\t\t\tyou're importing, chaining up to your root CA. Your Amazon Web Services Private CA-hosted or on-premises\n\t\t\troot certificate is the last in the chain, and each certificate in the chain signs the\n\t\t\tone preceding.
\nThis parameter must be supplied when you import a subordinate CA. When you import a\n\t\t\troot CA, there is no chain.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#Integer1To5000": { @@ -3172,7 +3235,7 @@ "SigningAlgorithm": { "target": "com.amazonaws.acmpca#SigningAlgorithm", "traits": { - "smithy.api#documentation": "The name of the algorithm that will be used to sign the certificate to be issued.
\nThis parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) much match the algorithm\n\t\t\t\tfamily of the CA's secret key.
\nThe name of the algorithm that will be used to sign the certificate to be issued.
\nThis parameter should not be confused with the SigningAlgorithm parameter\n\t\t\tused to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of\n\t\t\t\tthe CA's secret key.
\nInformation describing the start of the validity period of the certificate. This\n\t\t\tparameter sets the “Not Before\" date for the certificate.
\nBy default, when issuing a certificate, Amazon Web Services Private CA sets the \"Not Before\" date to the\n\t\t\tissuance time minus 60 minutes. This compensates for clock inconsistencies across\n\t\t\tcomputer systems. The ValidityNotBefore parameter can be used to customize\n\t\t\tthe “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore\n\t\t\tparameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time,\n\t\t\tusing the Validity type value ABSOLUTE. For more information,\n\t\t\tsee Validity in this API reference and Validity\n\t\t\tin RFC 5280.
Information describing the start of the validity period of the certificate. This\n\t\t\tparameter sets the “Not Before\" date for the certificate.
\nBy default, when issuing a certificate, Amazon Web Services Private CA sets the \"Not Before\" date to the\n\t\t\tissuance time minus 60 minutes. This compensates for clock inconsistencies across\n\t\t\tcomputer systems. The ValidityNotBefore parameter can be used to customize\n\t\t\tthe “Not Before” value.
Unlike the Validity parameter, the ValidityNotBefore\n\t\t\tparameter is optional.
The ValidityNotBefore value is expressed as an explicit date and time,\n\t\t\tusing the Validity type value ABSOLUTE. For more information,\n\t\t\tsee Validity in\n\t\t\tthis API reference and Validity\n\t\t\tin RFC 5280.
Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you\n\t\t\tcall IssueCertificate multiple times with the same\n\t\t\tidempotency token within one minute, Amazon Web Services Private CA recognizes that you are requesting only\n\t\t\tone certificate and will issue only one. If you change the idempotency token for each\n\t\t\tcall, Amazon Web Services Private CA recognizes that you are requesting multiple certificates.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#IssueCertificateResponse": { @@ -3212,6 +3278,9 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the issued certificate and the certificate serial\n\t\t\tnumber. This is of the form:
\n\n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245\n \n
Use this parameter to filter the returned set of certificate authorities based on\n\t\t\ttheir owner. The default is SELF.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#ListCertificateAuthoritiesResponse": { @@ -3404,6 +3476,9 @@ "smithy.api#documentation": "When the list is truncated, this value is present and should be used for the\n\t\t\t\tNextToken parameter in a subsequent pagination request.
When paginating results, use this parameter to specify the maximum number of items to\n\t\t\treturn in the response. If additional items exist beyond the number you specify, the\n\t\t\t\tNextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve\n\t\t\tadditional items.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#ListPermissionsResponse": { @@ -3480,6 +3558,9 @@ "smithy.api#documentation": "When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#ListTags": { @@ -3533,6 +3614,9 @@ "smithy.api#documentation": "Use this parameter when paginating results to specify the maximum number of items to\n\t\t\treturn in the response. If additional items exist beyond the number you specify, the\n\t\t\t\tNextToken element is sent in the response. Use this\n\t\t\t\tNextToken value in a subsequent request to retrieve\n\t\t\tadditional items.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#ListTagsResponse": { @@ -3550,6 +3634,9 @@ "smithy.api#documentation": "When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.\n\t\t
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.acmpca#LockoutPreventedException": { @@ -3862,6 +3949,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#Qualifier": { @@ -3977,6 +4067,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#RevocationConfiguration": { @@ -4117,6 +4210,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#S3BucketName": { @@ -4368,6 +4464,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#TagKey": { @@ -4457,6 +4556,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#UpdateCertificateAuthority": { @@ -4513,6 +4615,9 @@ "smithy.api#documentation": "Status of your private CA.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.acmpca#Validity": { diff --git a/codegen/sdk-codegen/aws-models/amplifyuibuilder.2021-08-11.json b/codegen/sdk-codegen/aws-models/amplifyuibuilder.2021-08-11.json index cd6968b1759..73dd9a65013 100644 --- a/codegen/sdk-codegen/aws-models/amplifyuibuilder.2021-08-11.json +++ b/codegen/sdk-codegen/aws-models/amplifyuibuilder.2021-08-11.json @@ -81,6 +81,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobResource" + }, { "target": "com.amazonaws.amplifyuibuilder#ComponentResource" }, @@ -489,8 +492,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -502,8 +505,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -515,8 +518,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -528,8 +531,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -541,8 +544,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -554,8 +557,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -567,8 +570,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -580,8 +583,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -593,8 +596,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -606,8 +609,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -619,8 +622,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -632,8 +635,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -645,8 +648,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -658,8 +661,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -671,8 +674,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -684,8 +687,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -697,8 +700,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -710,8 +713,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -723,8 +726,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -736,8 +739,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -749,8 +752,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -762,8 +765,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -775,8 +778,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -788,8 +791,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -801,8 +804,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -814,8 +817,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -827,8 +830,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -840,8 +843,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -851,8 +854,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -864,8 +867,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -875,8 +878,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -888,8 +891,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -899,8 +902,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -912,8 +915,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -923,8 +926,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -936,8 +939,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -949,8 +952,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -962,8 +965,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -974,8 +977,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -986,8 +989,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } }, @@ -1002,6 +1005,666 @@ } } }, + "com.amazonaws.amplifyuibuilder#AppId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + }, + "smithy.api#pattern": "^d[a-z0-9]+$" + } + }, + "com.amazonaws.amplifyuibuilder#AssociatedFieldsList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenFeatureFlags": { + "type": "structure", + "members": { + "isRelationshipSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifes whether a code generation job supports data relationships.
" + } + }, + "isNonModelSupported": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether a code generation job supports non models.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the feature flags that you can specify for a code generation job.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataEnum": { + "type": "structure", + "members": { + "values": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataEnumValuesList", + "traits": { + "smithy.api#documentation": "The list of enum values in the generic data schema.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the enums in a generic data schema.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataEnumValuesList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataEnums": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataEnum" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataField": { + "type": "structure", + "members": { + "dataType": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataFieldDataType", + "traits": { + "smithy.api#documentation": "The data type for the generic data field.
", + "smithy.api#required": {} + } + }, + "dataTypeValue": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the data type for the generic data field.
", + "smithy.api#required": {} + } + }, + "required": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the generic data field is required.
", + "smithy.api#required": {} + } + }, + "readOnly": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the generic data field is read-only.
", + "smithy.api#required": {} + } + }, + "isArray": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the generic data field is an array.
", + "smithy.api#required": {} + } + }, + "relationship": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataRelationshipType", + "traits": { + "smithy.api#documentation": "The relationship of the generic data schema.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a field in a generic data schema.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataFieldDataType": { + "type": "enum", + "members": { + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "String" + } + }, + "INT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Int" + } + }, + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Float" + } + }, + "AWS_DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSDate" + } + }, + "AWS_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTime" + } + }, + "AWS_DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSDateTime" + } + }, + "AWS_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSTimestamp" + } + }, + "AWS_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSEmail" + } + }, + "AWS_URL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSURL" + } + }, + "AWS_IP_ADDRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSIPAddress" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Boolean" + } + }, + "AWS_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSJSON" + } + }, + "AWS_PHONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSPhone" + } + }, + "ENUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enum" + } + }, + "MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Model" + } + }, + "NON_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NonModel" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataFields": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataField" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataModel": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataFields", + "traits": { + "smithy.api#documentation": "The fields in the generic data model.
", + "smithy.api#required": {} + } + }, + "isJoinTable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the generic data model is a join table.
" + } + }, + "primaryKeys": { + "target": "com.amazonaws.amplifyuibuilder#CodegenPrimaryKeysList", + "traits": { + "smithy.api#documentation": "The primary keys of the generic data model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a model in a generic data schema.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataModels": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataModel" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataNonModel": { + "type": "structure", + "members": { + "fields": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataNonModelFields", + "traits": { + "smithy.api#documentation": "The fields in a generic data schema non model.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a non-model in a generic data schema.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataNonModelFields": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataField" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataNonModels": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.amplifyuibuilder#CodegenGenericDataNonModel" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenGenericDataRelationshipType": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.amplifyuibuilder#GenericDataRelationshipType", + "traits": { + "smithy.api#documentation": "The data relationship type.
", + "smithy.api#required": {} + } + }, + "relatedModelName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the related model in the data relationship.
", + "smithy.api#required": {} + } + }, + "relatedModelFields": { + "target": "com.amazonaws.amplifyuibuilder#RelatedModelFieldsList", + "traits": { + "smithy.api#documentation": "The related model fields in the data relationship.
" + } + }, + "canUnlinkAssociatedModel": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the relationship can unlink the associated model.
" + } + }, + "relatedJoinFieldName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the related join field in the data relationship.
" + } + }, + "relatedJoinTableName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the related join table in the data relationship.
" + } + }, + "belongsToFieldOnRelatedModel": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The value of the belongsTo field on the related data model.
The associated fields of the data relationship.
" + } + }, + "isHasManyIndex": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the @index directive is supported for a hasMany data relationship.
Describes the relationship between generic data models.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJob": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid", + "traits": { + "smithy.api#documentation": "The unique ID for the code generation job.
", + "smithy.api#required": {} + } + }, + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId", + "traits": { + "smithy.api#documentation": "The ID of the Amplify app associated with the code generation job.
", + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the backend environment associated with the code generation job.
", + "smithy.api#required": {} + } + }, + "renderConfig": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobRenderConfig", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read" + } + }, + "genericDataSchema": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobGenericDataSchema", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read" + } + }, + "autoGenerateForms": { + "target": "smithy.api#Boolean", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read", + "smithy.api#documentation": "Specifies whether to autogenerate forms in the code generation job.
" + } + }, + "features": { + "target": "com.amazonaws.amplifyuibuilder#CodegenFeatureFlags", + "traits": { + "aws.cloudformation#cfnMutability": "create-and-read" + } + }, + "status": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobStatus", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "The status of the code generation job.
" + } + }, + "statusMessage": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "The customized status message for the code generation job.
" + } + }, + "asset": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobAsset", + "traits": { + "aws.cloudformation#cfnMutability": "read", + "smithy.api#documentation": "The CodegenJobAsset to use for the code generation job.
One or more key-value pairs to use when tagging the code generation job.
" + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time that the code generation job was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time that the code generation job was modified.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configuration for a code generation job that is associated with an Amplify app.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.amplifyuibuilder#CodegenJobResource" + } + ] + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobAsset": { + "type": "structure", + "members": { + "downloadUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL to use to access the asset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an asset for a code generation job.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobGenericDataSchema": { + "type": "structure", + "members": { + "dataSourceType": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobGenericDataSourceType", + "traits": { + "smithy.api#documentation": "The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.
The name of a CodegenGenericDataModel.
The name of a CodegenGenericDataEnum.
The name of a CodegenGenericDataNonModel.
Describes the data schema for a code generation job.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobGenericDataSourceType": { + "type": "enum", + "members": { + "DATA_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataStore" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobRenderConfig": { + "type": "union", + "members": { + "react": { + "target": "com.amazonaws.amplifyuibuilder#ReactStartCodegenJobData", + "traits": { + "smithy.api#documentation": "The name of the ReactStartCodegenJobData object.
Describes the configuration information for rendering the UI component associated the code generation job.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobResource": { + "type": "resource", + "identifiers": { + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid" + }, + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId" + }, + "environmentName": { + "target": "smithy.api#String" + } + }, + "create": { + "target": "com.amazonaws.amplifyuibuilder#StartCodegenJob" + }, + "read": { + "target": "com.amazonaws.amplifyuibuilder#GetCodegenJob" + }, + "list": { + "target": "com.amazonaws.amplifyuibuilder#ListCodegenJobs" + }, + "traits": { + "aws.api#arn": { + "template": "app/{appId}/environment/{environmentName}/codegen-jobs/{id}" + }, + "aws.cloudformation#cfnResource": { + "name": "CodegenJob", + "additionalSchemas": [ + "com.amazonaws.amplifyuibuilder#CodegenJob" + ] + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag/${TagKey}" + ] + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "in_progress" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "failed" + } + }, + "SUCCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "succeeded" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobSummary": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId", + "traits": { + "smithy.api#documentation": "The unique ID of the Amplify app associated with the code generation job.
", + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the backend environment associated with the code generation job.
", + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid", + "traits": { + "smithy.api#documentation": "The unique ID for the code generation job summary.
", + "smithy.api#required": {} + } + }, + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time that the code generation job summary was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "modifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The time that the code generation job summary was modified.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the basic information about the code generation job.
" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobSummary" + } + }, + "com.amazonaws.amplifyuibuilder#CodegenPrimaryKeysList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.amplifyuibuilder#Component": { "type": "structure", "members": { @@ -1916,7 +2579,7 @@ "aws.iam#requiredActions": [ "amplify:GetApp" ], - "smithy.api#documentation": "Creates a new form for an Amplify app.
", + "smithy.api#documentation": "Creates a new form for an Amplify.
", "smithy.api#http": { "uri": "/app/{appId}/environment/{environmentName}/forms", "method": "POST" @@ -3479,6 +4142,111 @@ "target": "com.amazonaws.amplifyuibuilder#FormSummary" } }, + "com.amazonaws.amplifyuibuilder#GenericDataRelationshipType": { + "type": "enum", + "members": { + "HAS_MANY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAS_MANY" + } + }, + "HAS_ONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAS_ONE" + } + }, + "BELONGS_TO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BELONGS_TO" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#GetCodegenJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#GetCodegenJobRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#GetCodegenJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ThrottlingException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], + "smithy.api#documentation": "Returns an existing code generation job.
", + "smithy.api#http": { + "uri": "/app/{appId}/environment/{environmentName}/codegen-jobs/{id}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#GetCodegenJobRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId", + "traits": { + "smithy.api#documentation": "The unique ID of the Amplify app associated with the code generation job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the backend environment that is a part of the Amplify app associated with the code generation job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "id": { + "target": "com.amazonaws.amplifyuibuilder#Uuid", + "traits": { + "smithy.api#documentation": "The unique ID of the code generation job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amplifyuibuilder#GetCodegenJobResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJob", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The configuration settings for the code generation job.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amplifyuibuilder#GetComponent": { "type": "operation", "input": { @@ -3788,6 +4556,63 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.amplifyuibuilder#JSModule": { + "type": "enum", + "members": { + "ES2020": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es2020" + } + }, + "ESNEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "esnext" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#JSScript": { + "type": "enum", + "members": { + "JSX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "jsx" + } + }, + "TSX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "tsx" + } + }, + "JS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "js" + } + } + } + }, + "com.amazonaws.amplifyuibuilder#JSTarget": { + "type": "enum", + "members": { + "ES2015": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es2015" + } + }, + "ES2020": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "es2020" + } + } + } + }, "com.amazonaws.amplifyuibuilder#LabelDecorator": { "type": "string", "traits": { @@ -3807,6 +4632,112 @@ ] } }, + "com.amazonaws.amplifyuibuilder#ListCodegenJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#ListCodegenJobsRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#ListCodegenJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ThrottlingException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], + "smithy.api#documentation": "Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
", + "smithy.api#http": { + "uri": "/app/{appId}/environment/{environmentName}/codegen-jobs", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "entities" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.amplifyuibuilder#ListCodegenJobsLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.amplifyuibuilder#ListCodegenJobsRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId", + "traits": { + "smithy.api#documentation": "The unique ID for the Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the backend environment that is a part of the Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token to request the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.amplifyuibuilder#ListCodegenJobsLimit", + "traits": { + "smithy.api#default": 100, + "smithy.api#documentation": "The maximum number of jobs to retrieve.
", + "smithy.api#httpQuery": "maxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amplifyuibuilder#ListCodegenJobsResponse": { + "type": "structure", + "members": { + "entities": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobSummaryList", + "traits": { + "smithy.api#documentation": "The list of code generation jobs for the Amplify app.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amplifyuibuilder#ListComponents": { "type": "operation", "input": { @@ -4268,6 +5199,46 @@ } } }, + "com.amazonaws.amplifyuibuilder#ReactStartCodegenJobData": { + "type": "structure", + "members": { + "module": { + "target": "com.amazonaws.amplifyuibuilder#JSModule", + "traits": { + "smithy.api#documentation": "The JavaScript module type.
" + } + }, + "target": { + "target": "com.amazonaws.amplifyuibuilder#JSTarget", + "traits": { + "smithy.api#documentation": "The ECMAScript specification to use.
" + } + }, + "script": { + "target": "com.amazonaws.amplifyuibuilder#JSScript", + "traits": { + "smithy.api#documentation": "The file type to use for a JavaScript project.
" + } + }, + "renderTypeDeclarations": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the code generation job should render type declaration files.
" + } + }, + "inlineSourceMap": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the code generation job should render inline source maps.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the code generation job configuration for a React project.
" + } + }, "com.amazonaws.amplifyuibuilder#RefreshToken": { "type": "operation", "input": { @@ -4350,6 +5321,12 @@ } } }, + "com.amazonaws.amplifyuibuilder#RelatedModelFieldsList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.amplifyuibuilder#ResourceConflictException": { "type": "structure", "members": { @@ -4490,6 +5467,132 @@ "target": "com.amazonaws.amplifyuibuilder#SortProperty" } }, + "com.amazonaws.amplifyuibuilder#StartCodegenJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.amplifyuibuilder#StartCodegenJobRequest" + }, + "output": { + "target": "com.amazonaws.amplifyuibuilder#StartCodegenJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.amplifyuibuilder#InternalServerException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#InvalidParameterException" + }, + { + "target": "com.amazonaws.amplifyuibuilder#ThrottlingException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "amplify:GetApp" + ], + "smithy.api#documentation": "Starts a code generation job for for a specified Amplify app and backend environment.
", + "smithy.api#http": { + "uri": "/app/{appId}/environment/{environmentName}/codegen-jobs", + "method": "POST" + } + } + }, + "com.amazonaws.amplifyuibuilder#StartCodegenJobData": { + "type": "structure", + "members": { + "renderConfig": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobRenderConfig", + "traits": { + "smithy.api#documentation": "The code generation configuration for the codegen job.
", + "smithy.api#required": {} + } + }, + "genericDataSchema": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJobGenericDataSchema", + "traits": { + "smithy.api#documentation": "The data schema to use for a code generation job.
" + } + }, + "autoGenerateForms": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to autogenerate forms in the code generation job.
" + } + }, + "features": { + "target": "com.amazonaws.amplifyuibuilder#CodegenFeatureFlags", + "traits": { + "smithy.api#documentation": "The feature flags for a code generation job.
" + } + }, + "tags": { + "target": "com.amazonaws.amplifyuibuilder#Tags", + "traits": { + "smithy.api#documentation": "One or more key-value pairs to use when tagging the code generation job data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The code generation job resource configuration.
" + } + }, + "com.amazonaws.amplifyuibuilder#StartCodegenJobRequest": { + "type": "structure", + "members": { + "appId": { + "target": "com.amazonaws.amplifyuibuilder#AppId", + "traits": { + "smithy.api#documentation": "The unique ID for the Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "environmentName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the backend environment that is a part of the Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The idempotency token used to ensure that the code generation job request completes only once.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + }, + "codegenJobToCreate": { + "target": "com.amazonaws.amplifyuibuilder#StartCodegenJobData", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The code generation job resource configuration.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.amplifyuibuilder#StartCodegenJobResponse": { + "type": "structure", + "members": { + "entity": { + "target": "com.amazonaws.amplifyuibuilder#CodegenJob", + "traits": { + "smithy.api#documentation": "The code generation job for a UI component that is associated with an Amplify app.
", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.amplifyuibuilder#StorageAccessLevel": { "type": "string", "traits": { @@ -4772,6 +5875,19 @@ "target": "com.amazonaws.amplifyuibuilder#ThemeValues" } }, + "com.amazonaws.amplifyuibuilder#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.amplifyuibuilder#TokenProviders": { "type": "string", "traits": { diff --git a/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json index 36f6d459aa8..0e172cdfce1 100644 --- a/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json +++ b/codegen/sdk-codegen/aws-models/appflow.2020-08-23.json @@ -2646,7 +2646,7 @@ "Type": { "target": "com.amazonaws.appflow#DataTransferApiType", "traits": { - "smithy.api#documentation": "You can specify one of the following types:
\nThe default. Optimizes a flow for datasets that fluctuate in size from small to\n large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on\n the amount of data that the run transfers.
\nA synchronous API. This type of API optimizes a flow for small to medium-sized datasets.
\nAn asynchronous API. This type of API optimizes a flow for large datasets.
\nYou can specify one of the following types:
\nThe default. Optimizes a flow for datasets that fluctuate in size from small to\n large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type\n based on the amount of data that the run transfers.
\nA synchronous API. This type of API optimizes a flow for small to medium-sized\n datasets.
\nAn asynchronous API. This type of API optimizes a flow for large datasets.
\nDescribes the status of an attempt from Amazon AppFlow to register a resource.
\nWhen you run a flow that you've configured to use a metadata catalog, Amazon AppFlow\n registers a metadata table and data partitions with that catalog. This operation provides the\n status of that registration attempt. The operation also indicates how many related resources\n Amazon AppFlow created or updated.
" } }, + "com.amazonaws.appflow#ResetConnectorMetadataCache": { + "type": "operation", + "input": { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCacheRequest" + }, + "output": { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCacheResponse" + }, + "errors": [ + { + "target": "com.amazonaws.appflow#ConflictException" + }, + { + "target": "com.amazonaws.appflow#InternalServerException" + }, + { + "target": "com.amazonaws.appflow#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.appflow#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Resets metadata about your connector entities that Amazon AppFlow stored in its\n cache. Use this action when you want Amazon AppFlow to return the latest information\n about the data that you have in a source application.
\nAmazon AppFlow returns metadata about your entities when you use the\n ListConnectorEntities or DescribeConnectorEntities actions. Following these actions, Amazon AppFlow caches the metadata to reduce the number of API requests that it must send to\n the source application. Amazon AppFlow automatically resets the cache once every hour,\n but you can use this action when you want to get the latest metadata right away.
", + "smithy.api#http": { + "method": "POST", + "uri": "/reset-connector-metadata-cache", + "code": 200 + } + } + }, + "com.amazonaws.appflow#ResetConnectorMetadataCacheRequest": { + "type": "structure", + "members": { + "connectorProfileName": { + "target": "com.amazonaws.appflow#ConnectorProfileName", + "traits": { + "smithy.api#documentation": "The name of the connector profile that you want to reset cached metadata for.
\nYou can omit this parameter if you're resetting the cache for any of the following\n connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this\n parameter in your request.
" + } + }, + "connectorType": { + "target": "com.amazonaws.appflow#ConnectorType", + "traits": { + "smithy.api#documentation": "The type of connector to reset cached metadata for.
\nYou must include this parameter in your request if you're resetting the cache for any of\n the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics,\n Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you\n can omit this parameter from your request.
" + } + }, + "connectorEntityName": { + "target": "com.amazonaws.appflow#EntityName", + "traits": { + "smithy.api#documentation": "Use this parameter if you want to reset cached metadata about the details for an\n individual entity.
\nIf you don't include this parameter in your request, Amazon AppFlow only resets\n cached metadata about entity names, not entity details.
" + } + }, + "entitiesPath": { + "target": "com.amazonaws.appflow#EntitiesPath", + "traits": { + "smithy.api#documentation": "Use this parameter only if you’re resetting the cached metadata about a nested entity.\n Only some connectors support nested entities. A nested entity is one that has another entity\n as a parent. To use this parameter, specify the name of the parent entity.
\nTo look up the parent-child relationship of entities, you can send a ListConnectorEntities\n request that omits the entitiesPath parameter. Amazon AppFlow will return a list of\n top-level entities. For each one, it indicates whether the entity has nested entities. Then,\n in a subsequent ListConnectorEntities request, you can specify a parent entity name for the\n entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that\n parent.
" + } + }, + "apiVersion": { + "target": "com.amazonaws.appflow#ApiVersion", + "traits": { + "smithy.api#documentation": "The API version that you specified in the connector profile that you’re resetting cached\n metadata for. You must use this parameter only if the connector supports multiple API versions\n or if the connector type is CustomConnector.
\nTo look up how many versions a connector supports, use the DescribeConnectors action. In\n the response, find the value that Amazon AppFlow returns for the connectorVersion\n parameter.
\nTo look up the connector type, use the DescribeConnectorProfiles action. In the response,\n find the value that Amazon AppFlow returns for the connectorType parameter.
\nTo look up the API version that you specified in a connector profile, use the\n DescribeConnectorProfiles action.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.appflow#ResetConnectorMetadataCacheResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.appflow#ResourceNotFoundException": { "type": "structure", "members": { @@ -7954,6 +8030,9 @@ { "target": "com.amazonaws.appflow#RegisterConnector" }, + { + "target": "com.amazonaws.appflow#ResetConnectorMetadataCache" + }, { "target": "com.amazonaws.appflow#StartFlow" }, diff --git a/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json b/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json index de226719749..f36828d784d 100644 --- a/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json +++ b/codegen/sdk-codegen/aws-models/application-discovery-service.2015-11-01.json @@ -121,7 +121,7 @@ "name": "discovery" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Application Discovery Service helps you plan application migration projects. It\n automatically identifies servers, virtual machines (VMs), and network dependencies in your\n on-premises data centers. For more information, see the Amazon Web Services Application Discovery Service FAQ. \n Application Discovery Service offers three ways of performing discovery and\n collecting data about your on-premises servers:
\n\n Agentless discovery is recommended for environments\n that use VMware vCenter Server. This mode doesn't require you to install an agent on each\n host. It does not work in non-VMware environments.
\nAgentless discovery gathers server information regardless of the operating\n systems, which minimizes the time required for initial on-premises infrastructure\n assessment.
\nAgentless discovery doesn't collect information about network dependencies, only\n agent-based discovery collects that information.
\n\n Agent-based discovery collects a richer set of data\n than agentless discovery by using the Amazon Web Services Application Discovery Agent, which you install\n on one or more hosts in your data center.
\nThe agent captures infrastructure and application information, including an\n inventory of running processes, system performance information, resource utilization,\n and network dependencies.
\nThe information collected by agents is secured at rest and in transit to the\n Application Discovery Service database in the cloud.
\n\n Amazon Web Services Partner Network (APN) solutions integrate with\n Application Discovery Service, enabling you to import details of your on-premises\n environment directly into Migration Hub without using the discovery connector or discovery\n agent.
\nThird-party application discovery tools can query Amazon Web Services Application Discovery\n Service, and they can write to the Application Discovery Service database using the\n public API.
\nIn this way, you can import data into Migration Hub and view it, so that you can\n associate applications with servers and track migrations.
\n\n Recommendations\n
\nWe recommend that you use agent-based discovery for non-VMware environments, and\n whenever you want to collect information about network dependencies. You can run agent-based\n and agentless discovery simultaneously. Use agentless discovery to complete the initial\n infrastructure assessment quickly, and then install agents on select hosts to collect\n additional information.
\n\n Working With This Guide\n
\nThis API reference provides descriptions, syntax, and usage examples for each of the\n actions and data types for Application Discovery Service. The topic for each action shows the\n API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services\n SDKs.
\nRemember that you must set your Migration Hub home region before you call any of\n these APIs.
\nYou must make API calls for write actions (create, notify, associate, disassociate,\n import, or put) while in your home region, or a HomeRegionNotSetException\n error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside\n of your home region.
\nAlthough it is unlikely, the Migration Hub home region could change. If you call\n APIs outside the home region, an InvalidInputException is returned.
You must call GetHomeRegion to obtain the latest Migration Hub home\n region.
This guide is intended for use with the Amazon Web Services Application\n Discovery Service User Guide.
\nAll data is handled according to the Amazon Web Services \n Privacy Policy. You can operate Application Discovery Service offline to inspect\n collected data before it is shared with the service.
\nAmazon Web Services Application Discovery Service (Application Discovery Service) helps you plan application migration projects. It automatically\n identifies servers, virtual machines (VMs), and network dependencies in your on-premises data\n centers. For more information, see the Amazon Web Services Application Discovery Service FAQ.
\nApplication Discovery Service offers three ways of performing discovery and collecting\n data about your on-premises servers:
\n\n Agentless discovery using\n Amazon Web Services Application Discovery Service Agentless Collector (Agentless Collector), which doesn't require you\n to install an agent on each host.
\nAgentless Collector gathers server information regardless of the\n operating systems, which minimizes the time required for initial on-premises\n infrastructure assessment.
\nAgentless Collector doesn't collect information about network\n dependencies, only agent-based discovery collects that information.\n
\n\n Agent-based discovery using the Amazon Web Services Application\n Discovery Agent (Application Discovery Agent) collects a richer set of data than agentless\n discovery, which you install on one or more hosts in your data center.
\nThe agent captures infrastructure and application information, including an\n inventory of running processes, system performance information, resource utilization,\n and network dependencies.
\nThe information collected by agents is secured at rest and in transit to the\n Application Discovery Service database in the Amazon Web Services cloud. For more information, see\n Amazon Web Services Application\n Discovery Agent.
\n\n Amazon Web Services Partner Network (APN) solutions integrate with\n Application Discovery Service, enabling you to import details of your on-premises\n environment directly into Amazon Web Services Migration Hub (Migration Hub) without using\n Agentless Collector or Application Discovery Agent.
\nThird-party application discovery tools can query Amazon Web Services Application Discovery\n Service, and they can write to the Application Discovery Service database using the\n public API.
\nIn this way, you can import data into Migration Hub and view it, so that you can\n associate applications with servers and track migrations.
\n\n Working With This Guide\n
\nThis API reference provides descriptions, syntax, and usage examples for each of the\n actions and data types for Application Discovery Service. The topic for each action shows the\n API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to\n access an API that is tailored to the programming language or platform that you're using. For\n more information, see Amazon Web Services SDKs.
\nRemember that you must set your Migration Hub home Region before you call any of\n these APIs.
\nYou must make API calls for write actions (create, notify, associate, disassociate,\n import, or put) while in your home Region, or a HomeRegionNotSetException\n error is returned.
API calls for read actions (list, describe, stop, and delete) are permitted outside\n of your home Region.
\nAlthough it is unlikely, the Migration Hub home Region could change. If you call\n APIs outside the home Region, an InvalidInputException is returned.
You must call GetHomeRegion to obtain the latest Migration Hub home\n Region.
This guide is intended for use with the Amazon Web Services Application Discovery Service User\n Guide.
\nAll data is handled according to the Amazon Web Services Privacy Policy. You can operate Application Discovery Service offline to\n inspect collected data before it is shared with the service.
\nThe agent/connector ID.
" + "smithy.api#documentation": "The agent ID.
" } }, "operationSucceeded": { "target": "com.amazonaws.applicationdiscoveryservice#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Information about the status of the StartDataCollection and\n StopDataCollection operations. The system has recorded the data collection\n operation. The agent/connector receives this command the next time it polls for a new command.\n
Information about the status of the StartDataCollection and\n StopDataCollection operations. The system has recorded the data collection\n operation. The agent receives this command the next time it polls for a new command.\n
Information about agents or connectors that were instructed to start collecting data.\n Information includes the agent/connector ID, a description of the operation, and whether the\n agent/connector configuration was updated.
" + "smithy.api#documentation": "Information about agents that were instructed to start collecting data.\n Information includes the agent ID, a description of the operation, and whether the\n agent configuration was updated.
" } }, "com.amazonaws.applicationdiscoveryservice#AgentConfigurationStatusList": { @@ -925,19 +925,19 @@ "agentId": { "target": "com.amazonaws.applicationdiscoveryservice#AgentId", "traits": { - "smithy.api#documentation": "The agent or connector ID.
" + "smithy.api#documentation": "The agent or collector ID.
" } }, "hostName": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "The name of the host where the agent or connector resides. The host can be a server or\n virtual machine.
" + "smithy.api#documentation": "The name of the host where the agent or collector resides. The host can be a server or\n virtual machine.
" } }, "agentNetworkInfoList": { "target": "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfoList", "traits": { - "smithy.api#documentation": "Network details about the host where the agent or connector resides.
" + "smithy.api#documentation": "Network details about the host where the agent or collector resides.
" } }, "connectorId": { @@ -949,25 +949,25 @@ "version": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "The agent or connector version.
" + "smithy.api#documentation": "The agent or collector version.
" } }, "health": { "target": "com.amazonaws.applicationdiscoveryservice#AgentStatus", "traits": { - "smithy.api#documentation": "The health of the agent or connector.
" + "smithy.api#documentation": "The health of the agent.
" } }, "lastHealthPingTime": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "Time since agent or connector health was reported.
" + "smithy.api#documentation": "Time since agent health was reported.
" } }, "collectionStatus": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "Status of the collection process for an agent or connector.
" + "smithy.api#documentation": "Status of the collection process for an agent.
" } }, "agentType": { @@ -984,7 +984,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about agents or connectors associated with the user’s Amazon Web Services account.\n Information includes agent or connector IDs, IP addresses, media access control (MAC)\n addresses, agent or connector health, hostname where the agent or connector resides, and agent\n version for each agent.
" + "smithy.api#documentation": "Information about agents associated with the user’s Amazon Web Services account.\n Information includes agent IDs, IP addresses, media access control (MAC)\n addresses, agent or collector status, hostname where the agent resides, and agent\n version for each agent.
" } }, "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfo": { @@ -993,18 +993,18 @@ "ipAddress": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "The IP address for the host where the agent/connector resides.
" + "smithy.api#documentation": "The IP address for the host where the agent/collector resides.
" } }, "macAddress": { "target": "com.amazonaws.applicationdiscoveryservice#String", "traits": { - "smithy.api#documentation": "The MAC address for the host where the agent/connector resides.
" + "smithy.api#documentation": "The MAC address for the host where the agent/collector resides.
" } } }, "traits": { - "smithy.api#documentation": "Network details about the host where the agent/connector resides.
" + "smithy.api#documentation": "Network details about the host where the agent/collector resides.
" } }, "com.amazonaws.applicationdiscoveryservice#AgentNetworkInfoList": { @@ -1162,7 +1162,7 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon Web Services user account does not have permission to perform the action. Check the IAM\n policy associated with this account.
", + "smithy.api#documentation": "The user does not have permission to perform the action. Check the IAM\n policy associated with this user.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1462,7 +1462,7 @@ "statusDetail": { "target": "com.amazonaws.applicationdiscoveryservice#StringMax255", "traits": { - "smithy.api#documentation": "Contains information about any errors that have occurred. This data type can have the\n following values:
\nACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon\n Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery\n Service User Guide.
\nDELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data\n Firehose delivery streams. Reduce the number of streams or request a limit increase and\n try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide.
\nFIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because\n your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data\n Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by\n Attaching Policies in the Application Discovery Service User Guide.
\nFIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state\n because your IAM User is missing one or more of the Kinesis data delivery\n streams.
\nINTERNAL_FAILURE - The Data Exploration feature is in an error state because of an\n internal failure. Try again later. If this problem persists, contact Amazon Web Services\n Support.
\nLAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions\n to start continuous export. For more information, see \n Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the\n Amazon Web Services Lake Formation Developer Guide.
\nYou can use one of the following two ways to resolve this issue.
\nIf you don’t want to use the Lake Formation permission model, you can change\n the default Data Catalog settings to use only Amazon Web Services Identity and Access Management\n (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation\n Developer Guide.
\nYou can give the service-linked IAM roles\n AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and\n AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For\n more information, see \n Granting Database Permissions in the Lake Formation\n Developer Guide.
\nAWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant\n database creator permissions, which gives the role database creation ability and\n implicit permissions for any created tables. For more information, see \n Implicit Lake Formation Permissions in the Lake\n Formation Developer Guide.
\nAWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all\n tables in the database.
\nS3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the\n number of S3 buckets or request a limit increase and try again. For more\n information, see Bucket\n Restrictions and Limitations in the Amazon Simple Storage Service Developer\n Guide.
\nS3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You\n must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
\nContains information about any errors that have occurred. This data type can have the\n following values:
\nACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon\n Athena. Contact your Amazon Web Services administrator for help. For more information, see Setting Up Amazon Web Services Application Discovery Service in the Application Discovery\n Service User Guide.
\nDELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data\n Firehose delivery streams. Reduce the number of streams or request a limit increase and\n try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer\n Guide.
\nFIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because\n your user is missing the Amazon Web ServicesApplicationDiscoveryServiceFirehose role. Turn on Data\n Exploration in Amazon Athena and try again. For more information, see Creating the Amazon Web ServicesApplicationDiscoveryServiceFirehose Role in the Application Discovery Service User Guide.
\nFIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state\n because your user is missing one or more of the Kinesis data delivery\n streams.
\nINTERNAL_FAILURE - The Data Exploration feature is in an error state because of an\n internal failure. Try again later. If this problem persists, contact Amazon Web Services\n Support.
\nLAKE_FORMATION_ACCESS_DENIED - You don't have sufficient lake formation permissions\n to start continuous export. For more information, see \n Upgrading Amazon Web Services Glue Data Permissions to the Amazon Web Services Lake Formation Model in the\n Amazon Web Services Lake Formation Developer Guide.
\nYou can use one of the following two ways to resolve this issue.
\nIf you don’t want to use the Lake Formation permission model, you can change\n the default Data Catalog settings to use only Amazon Web Services Identity and Access Management\n (IAM) access control for new databases. For more information, see Change Data Catalog Settings in the Lake Formation Developer\n Guide.
\nYou can give the service-linked IAM roles\n AWSServiceRoleForApplicationDiscoveryServiceContinuousExport and\n AWSApplicationDiscoveryServiceFirehose the required Lake Formation permissions. For\n more information, see \n Granting Database Permissions in the Lake Formation Developer\n Guide.
\nAWSServiceRoleForApplicationDiscoveryServiceContinuousExport - Grant\n database creator permissions, which gives the role database creation ability and\n implicit permissions for any created tables. For more information, see \n Implicit Lake Formation Permissions in the Lake Formation\n Developer Guide.
\nAWSApplicationDiscoveryServiceFirehose - Grant describe permissions for all\n tables in the database.
\nS3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the\n number of S3 buckets or request a limit increase and try again. For more information, see\n Bucket Restrictions and Limitations in the Amazon Simple Storage Service\n Developer Guide.
\nS3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You\n must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
\nThe number of active Agentless Collector collectors.
", "smithy.api#required": {} } }, @@ -1762,6 +1763,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, + "smithy.api#documentation": "The number of healthy Agentless Collector collectors.
", "smithy.api#required": {} } }, @@ -1769,6 +1771,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, + "smithy.api#documentation": "The number of deny-listed Agentless Collector collectors.
", "smithy.api#required": {} } }, @@ -1776,6 +1779,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, + "smithy.api#documentation": "The number of Agentless Collector collectors with SHUTDOWN status.\n
The number of unhealthy Agentless Collector collectors.
", "smithy.api#required": {} } }, @@ -1790,6 +1795,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, + "smithy.api#documentation": "The total number of Agentless Collector collectors.
", "smithy.api#required": {} } }, @@ -1797,9 +1803,13 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, + "smithy.api#documentation": "The number of unknown Agentless Collector collectors.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "The inventory data for installed Agentless Collector collectors.
" } }, "com.amazonaws.applicationdiscoveryservice#CustomerConnectorInfo": { @@ -1873,7 +1883,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The number of active Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The number of active Migration Evaluator collectors.
", "smithy.api#required": {} } }, @@ -1881,7 +1891,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The number of healthy Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The number of healthy Migration Evaluator collectors.
", "smithy.api#required": {} } }, @@ -1889,7 +1899,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The number of deny-listed Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The number of deny-listed Migration Evaluator collectors.
", "smithy.api#required": {} } }, @@ -1897,7 +1907,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The number of Migration Evaluator collectors with SHUTDOWN status.\n
The number of Migration Evaluator collectors with SHUTDOWN status.
\n The number of unhealthy Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The number of unhealthy Migration Evaluator collectors.
", "smithy.api#required": {} } }, @@ -1913,7 +1923,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The total number of Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The total number of Migration Evaluator collectors.
", "smithy.api#required": {} } }, @@ -1921,13 +1931,13 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "\n The number of unknown Migration Evaluator collectors.\n
", + "smithy.api#documentation": "The number of unknown Migration Evaluator collectors.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n The inventory data for installed Migration Evaluator collectors.\n
" + "smithy.api#documentation": "The inventory data for installed Migration Evaluator collectors.
" } }, "com.amazonaws.applicationdiscoveryservice#DataSource": { @@ -2087,7 +2097,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists agents or connectors as specified by ID or other filters. All agents/connectors\n associated with your user account can be listed if you call DescribeAgents as is\n without passing any parameters.
Lists agents or collectors as specified by ID or other filters. All agents/collectors\n associated with your user can be listed if you call DescribeAgents as is\n without passing any parameters.
The agent or the Connector IDs for which you want information. If you specify no IDs,\n the system returns information about all agents/Connectors associated with your Amazon Web Services user\n account.
" + "smithy.api#documentation": "The agent or the collector IDs for which you want information. If you specify no IDs,\n the system returns information about all agents/collectors associated with your user.
" } }, "filters": { @@ -2109,7 +2119,7 @@ "target": "com.amazonaws.applicationdiscoveryservice#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The total number of agents/Connectors to return in a single page of output. The maximum\n value is 100.
" + "smithy.api#documentation": "The total number of agents/collectors to return in a single page of output. The maximum\n value is 100.
" } }, "nextToken": { @@ -2129,7 +2139,7 @@ "agentsInfo": { "target": "com.amazonaws.applicationdiscoveryservice#AgentsInfo", "traits": { - "smithy.api#documentation": "Lists agents or the Connector by ID or lists all agents/Connectors associated with your\n user account if you did not specify an agent/Connector ID. The output includes agent/Connector\n IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name\n where the agent/Connector resides, and the version number of each agent/Connector.
" + "smithy.api#documentation": "Lists agents or the collector by ID or lists all agents/collectors associated with your\n user, if you did not specify an agent/collector ID. The output includes agent/collector\n IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name\n where the agent/collector resides, and the version number of each agent/collector.
" } }, "nextToken": { @@ -2248,7 +2258,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists exports as specified by ID. All continuous exports associated with your user\n account can be listed if you call DescribeContinuousExports as is without passing\n any parameters.
Lists exports as specified by ID. All continuous exports associated with your user\n can be listed if you call DescribeContinuousExports as is without passing\n any parameters.
Retrieves a list of configuration items that have tags as specified by the key-value\n pairs, name and value, passed to the optional parameter filters.
There are three valid tag filter names:
\ntagKey
\ntagValue
\nconfigurationId
\nAlso, all configuration items associated with your user account that have tags can be\n listed if you call DescribeTags as is without passing any parameters.
Retrieves a list of configuration items that have tags as specified by the key-value\n pairs, name and value, passed to the optional parameter filters.
There are three valid tag filter names:
\ntagKey
\ntagValue
\nconfigurationId
\nAlso, all configuration items associated with your user that have tags can be\n listed if you call DescribeTags as is without passing any parameters.
\n If set to true, the export \n preferences\n is set to Ec2RecommendationsExportPreferences.\n
\n The recommended EC2 instance type that matches the CPU usage metric of server performance data.\n
" + } + }, + "ramPerformanceMetricBasis": { + "target": "com.amazonaws.applicationdiscoveryservice#UsageMetricBasis", + "traits": { + "smithy.api#documentation": "\n The recommended EC2 instance type that matches the Memory usage metric of server performance data.\n
" + } + }, + "tenancy": { + "target": "com.amazonaws.applicationdiscoveryservice#Tenancy", + "traits": { + "smithy.api#documentation": "\n The target tenancy to use for your recommended EC2 instances.\n
" + } + }, + "excludedInstanceTypes": { + "target": "com.amazonaws.applicationdiscoveryservice#ExcludedInstanceTypes", + "traits": { + "smithy.api#documentation": "\n An array of instance types to exclude from recommendations.\n
" + } + }, + "preferredRegion": { + "target": "com.amazonaws.applicationdiscoveryservice#UserPreferredRegion", + "traits": { + "smithy.api#documentation": "\n The target Amazon Web Services Region for the recommendations. \n You can use any of the Region codes available for the chosen service, \n as listed in Amazon Web Services service endpoints in the Amazon Web Services General Reference.\n
" + } + }, + "reservedInstanceOptions": { + "target": "com.amazonaws.applicationdiscoveryservice#ReservedInstanceOptions", + "traits": { + "smithy.api#documentation": "\n The contract type for a reserved instance. \n If blank, we assume an On-Demand instance is preferred.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Indicates that the exported data must include EC2 instance type matches for on-premises servers \n that are discovered through Amazon Web Services Application Discovery Service.\n
" + } + }, + "com.amazonaws.applicationdiscoveryservice#ExcludedInstanceTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.applicationdiscoveryservice#EC2InstanceType" + } + }, "com.amazonaws.applicationdiscoveryservice#ExportConfigurations": { "type": "operation", "input": { @@ -2760,12 +2837,6 @@ "traits": { "smithy.api#enumValue": "CSV" } - }, - "GRAPHML": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRAPHML" - } } } }, @@ -2775,6 +2846,12 @@ "target": "com.amazonaws.applicationdiscoveryservice#ExportDataFormat" } }, + "com.amazonaws.applicationdiscoveryservice#ExportEnabled": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, "com.amazonaws.applicationdiscoveryservice#ExportFilter": { "type": "structure", "members": { @@ -2877,6 +2954,20 @@ "smithy.api#documentation": "Information regarding the export status of discovered data. The value is an array of\n objects.
" } }, + "com.amazonaws.applicationdiscoveryservice#ExportPreferences": { + "type": "union", + "members": { + "ec2RecommendationsPreferences": { + "target": "com.amazonaws.applicationdiscoveryservice#Ec2RecommendationsExportPreferences", + "traits": { + "smithy.api#documentation": "\n If enabled, exported data includes EC2 instance type matches for on-premises servers \n discovered through Amazon Web Services Application Discovery Service.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Indicates the type of data that is being exported. Only one \n ExportPreferences can be enabled for a \n StartExportTask action. \n
\n Details about Migration Evaluator collectors, including collector status and health.\n
" + "smithy.api#documentation": "Details about Migration Evaluator collectors, including collector status and health.
" } }, "agentlessCollectorSummary": { - "target": "com.amazonaws.applicationdiscoveryservice#CustomerAgentlessCollectorInfo" + "target": "com.amazonaws.applicationdiscoveryservice#CustomerAgentlessCollectorInfo", + "traits": { + "smithy.api#documentation": "Details about Agentless Collector collectors, including status.
" + } } }, "traits": { @@ -3077,7 +3171,7 @@ } }, "traits": { - "smithy.api#documentation": "The home region is not set. Set the home region to continue.
", + "smithy.api#documentation": "The home Region is not set. Set the home Region to continue.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3625,6 +3719,23 @@ "com.amazonaws.applicationdiscoveryservice#NextToken": { "type": "string" }, + "com.amazonaws.applicationdiscoveryservice#OfferingClass": { + "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.applicationdiscoveryservice#OperationNotPermittedException": { "type": "structure", "members": { @@ -3675,6 +3786,58 @@ "target": "com.amazonaws.applicationdiscoveryservice#OrderByElement" } }, + "com.amazonaws.applicationdiscoveryservice#PurchasingOption": { + "type": "enum", + "members": { + "ALL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_UPFRONT" + } + }, + "PARTIAL_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIAL_UPFRONT" + } + }, + "NO_UPFRONT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_UPFRONT" + } + } + } + }, + "com.amazonaws.applicationdiscoveryservice#ReservedInstanceOptions": { + "type": "structure", + "members": { + "purchasingOption": { + "target": "com.amazonaws.applicationdiscoveryservice#PurchasingOption", + "traits": { + "smithy.api#documentation": "\n The payment plan to use for your Reserved Instance.\n
", + "smithy.api#required": {} + } + }, + "offeringClass": { + "target": "com.amazonaws.applicationdiscoveryservice#OfferingClass", + "traits": { + "smithy.api#documentation": "\n The flexibility to change the instance types needed for your Reserved Instance.\n
", + "smithy.api#required": {} + } + }, + "termLength": { + "target": "com.amazonaws.applicationdiscoveryservice#TermLength", + "traits": { + "smithy.api#documentation": "\n The preferred duration of the Reserved Instance term.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n Used to provide Reserved Instance preferences for the recommendation.\n
" + } + }, "com.amazonaws.applicationdiscoveryservice#ResourceInUseException": { "type": "structure", "members": { @@ -3838,7 +4001,7 @@ } ], "traits": { - "smithy.api#documentation": "Instructs the specified agents or connectors to start collecting data.
" + "smithy.api#documentation": "Instructs the specified agents to start collecting data.
" } }, "com.amazonaws.applicationdiscoveryservice#StartDataCollectionByAgentIdsRequest": { @@ -3847,7 +4010,7 @@ "agentIds": { "target": "com.amazonaws.applicationdiscoveryservice#AgentIds", "traits": { - "smithy.api#documentation": "The IDs of the agents or connectors from which to start collecting data. If you send a\n request to an agent/connector ID that you do not have permission to contact, according to your\n Amazon Web Services account, the service does not throw an exception. Instead, it returns the error in the\n Description field. If you send a request to multiple agents/connectors\n and you do not have permission to contact some of those agents/connectors, the system does not\n throw an exception. Instead, the system shows Failed in the\n Description field.
The IDs of the agents from which to start collecting data. If you send a request to an\n agent ID that you do not have permission to contact, according to your Amazon Web Services account, the\n service does not throw an exception. Instead, it returns the error in the\n Description field. If you send a request to multiple agents and you do\n not have permission to contact some of those agents, the system does not throw an exception.\n Instead, the system shows Failed in the Description\n field.
Information about agents or the connector that were instructed to start collecting\n data. Information includes the agent/connector ID, a description of the operation performed,\n and whether the agent/connector configuration was updated.
" + "smithy.api#documentation": "Information about agents that were instructed to start collecting data. Information\n includes the agent ID, a description of the operation performed, and whether the agent\n configuration was updated.
" } } }, @@ -3899,7 +4062,7 @@ } ], "traits": { - "smithy.api#documentation": "Begins the export of discovered data to an S3 bucket.
\n If you specify agentIds in a filter, the task exports up to 72 hours of\n detailed data collected by the identified Application Discovery Agent, including network,\n process, and performance details. A time range for exported agent data may be set by using\n startTime and endTime. Export of detailed agent data is limited to\n five concurrently running exports.
If you do not include an agentIds filter, summary data is exported that\n includes both Amazon Web Services Agentless Discovery Connector data and summary data from Amazon Web Services Discovery\n Agents. Export of summary data is limited to two exports per day.
Begins the export of a discovered data report to an Amazon S3 bucket managed by Amazon Web Services.
\nExports might provide an estimate of fees and savings based on certain information \n that you provide. Fee estimates do not include any taxes that might apply. \n Your actual fees and savings depend on a variety of factors, including your actual usage of Amazon Web Services \n services, which might vary from the estimates provided in this report.
\nIf you do not specify preferences or agentIds in the filter, a\n summary of all servers, applications, tags, and performance is generated. This data is an\n aggregation of all server data collected through on-premises tooling, file import, application\n grouping and applying tags.
If you specify agentIds in a filter, the task exports up to 72 hours of\n detailed data collected by the identified Application Discovery Agent, including network,\n process, and performance details. A time range for exported agent data may be set by using\n startTime and endTime. Export of detailed agent data is limited to\n five concurrently running exports. \n Export of detailed agent data is limited to two exports per day.
If you enable ec2RecommendationsPreferences in preferences \n , an\n Amazon EC2 instance matching the characteristics of each server in Application Discovery Service is generated. \n Changing the attributes of the ec2RecommendationsPreferences changes the\n criteria of the recommendation.
If a filter is present, it selects the single agentId of the Application\n Discovery Agent for which data is exported. The agentId can be found in the\n results of the DescribeAgents API or CLI. If no filter is present,\n startTime and endTime are ignored and exported data includes both\n Agentless Discovery Connector data and summary data from Application Discovery agents.\n
If a filter is present, it selects the single agentId of the Application\n Discovery Agent for which data is exported. The agentId can be found in the\n results of the DescribeAgents API or CLI. If no filter is present,\n startTime and endTime are ignored and exported data includes both\n Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery\n Agent agents.
The end timestamp for exported data from the single Application Discovery Agent\n selected in the filters. If no value is specified, exported data includes the most recent data\n collected by the agent.
" } + }, + "preferences": { + "target": "com.amazonaws.applicationdiscoveryservice#ExportPreferences", + "traits": { + "smithy.api#documentation": "\n Indicates the type of data that needs to be exported. Only one \n ExportPreferences can be enabled at any time.\n
" + } } }, "traits": { @@ -3977,7 +4146,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an import task, which allows you to import details of your on-premises environment\n directly into Amazon Web Services Migration Hub without having to use the Application Discovery Service (ADS)\n tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform\n migration assessment and planning directly from your imported data, including the ability to\n group your devices as applications and track their migration status.
\nTo start an import request, do this:
\nDownload the specially formatted comma separated value (CSV) import template, which\n you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
\nFill out the template with your server and application data.
\nUpload your import file to an Amazon S3 bucket, and make a note of it's Object URL.\n Your import file must be in the CSV format.
\nUse the console or the StartImportTask command with the Amazon Web Services CLI or one of\n the Amazon Web Services SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub\n Import in the Amazon Web Services Application Discovery Service User\n Guide.
\nThere are limits to the number of import tasks you can create (and delete) in an Amazon Web Services\n account. For more information, see Amazon Web Services Application\n Discovery Service Limits in the Amazon Web Services Application Discovery Service User\n Guide.
\nStarts an import task, which allows you to import details of your on-premises environment\n directly into Amazon Web Services Migration Hub without having to use the Amazon Web Services Application Discovery\n Service (Application Discovery Service) tools such as the Amazon Web Services Application Discovery Service Agentless Collector\n or Application Discovery Agent. This gives you the option to\n perform migration assessment and planning directly from your imported data, including the\n ability to group your devices as applications and track their migration status.
\nTo start an import request, do this:
\nDownload the specially formatted comma separated value (CSV) import template, which\n you can find here: https://s3.us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.
\nFill out the template with your server and application data.
\nUpload your import file to an Amazon S3 bucket, and make a note of it's Object URL.\n Your import file must be in the CSV format.
\nUse the console or the StartImportTask command with the Amazon Web Services CLI or one\n of the Amazon Web Services SDKs to import the records from your file.
For more information, including step-by-step procedures, see Migration Hub\n Import in the Amazon Web Services Application Discovery Service User\n Guide.
\nThere are limits to the number of import tasks you can create (and delete) in an Amazon Web Services\n account. For more information, see Amazon Web Services Application\n Discovery Service Limits in the Amazon Web Services Application Discovery Service User\n Guide.
\nInstructs the specified agents or connectors to stop collecting data.
" + "smithy.api#documentation": "Instructs the specified agents to stop collecting data.
" } }, "com.amazonaws.applicationdiscoveryservice#StopDataCollectionByAgentIdsRequest": { @@ -4131,7 +4300,7 @@ "agentIds": { "target": "com.amazonaws.applicationdiscoveryservice#AgentIds", "traits": { - "smithy.api#documentation": "The IDs of the agents or connectors from which to stop collecting data.
", + "smithy.api#documentation": "The IDs of the agents from which to stop collecting data.
", "smithy.api#required": {} } } @@ -4146,7 +4315,7 @@ "agentsConfigurationStatus": { "target": "com.amazonaws.applicationdiscoveryservice#AgentConfigurationStatusList", "traits": { - "smithy.api#documentation": "Information about the agents or connector that were instructed to stop collecting data.\n Information includes the agent/connector ID, a description of the operation performed, and\n whether the agent/connector configuration was updated.
" + "smithy.api#documentation": "Information about the agents that were instructed to stop collecting data. Information\n includes the agent ID, a description of the operation performed, and whether the agent\n configuration was updated.
" } } }, @@ -4239,6 +4408,40 @@ "com.amazonaws.applicationdiscoveryservice#TagValue": { "type": "string" }, + "com.amazonaws.applicationdiscoveryservice#Tenancy": { + "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.applicationdiscoveryservice#TermLength": { + "type": "enum", + "members": { + "ONE_YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_YEAR" + } + }, + "THREE_YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_YEAR" + } + } + } + }, "com.amazonaws.applicationdiscoveryservice#TimeStamp": { "type": "timestamp" }, @@ -4317,6 +4520,51 @@ "smithy.api#output": {} } }, + "com.amazonaws.applicationdiscoveryservice#UsageMetricBasis": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.applicationdiscoveryservice#UsageMetricBasisName", + "traits": { + "smithy.api#documentation": "\n A utilization metric that is used by the recommendations.\n
" + } + }, + "percentageAdjust": { + "target": "com.amazonaws.applicationdiscoveryservice#UsageMetricPercentageAdjust", + "traits": { + "smithy.api#documentation": "\n Specifies the percentage of the specified utilization metric that is used by the recommendations.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Specifies the performance metrics to use for the server that is used for recommendations.\n
" + } + }, + "com.amazonaws.applicationdiscoveryservice#UsageMetricBasisName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(p(\\d{1,2}|100)|AVG|SPEC|MAX)$" + } + }, + "com.amazonaws.applicationdiscoveryservice#UsageMetricPercentageAdjust": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0.0, + "max": 100.0 + } + } + }, + "com.amazonaws.applicationdiscoveryservice#UserPreferredRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 30 + }, + "smithy.api#pattern": "^[a-z]{2}-[a-z\\-]+-[0-9]+$" + } + }, "com.amazonaws.applicationdiscoveryservice#orderString": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json index 01df65aff32..31093485142 100644 --- a/codegen/sdk-codegen/aws-models/athena.2017-05-18.json +++ b/codegen/sdk-codegen/aws-models/athena.2017-05-18.json @@ -2678,7 +2678,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the KMS key that is used to encrypt the user's data stores in Athena.
" + "smithy.api#documentation": "Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
" } }, "com.amazonaws.athena#DataCatalog": { @@ -3188,6 +3188,12 @@ "traits": { "smithy.api#documentation": "Contains additional notebook engine MAP parameter\n mappings in the form of key-value pairs. To specify an Athena notebook that\n the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named\n NotebookId to AdditionalConfigs that has the value of the\n Athena notebook ID.
Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.
" + } } }, "traits": { @@ -8656,7 +8662,7 @@ "CustomerContentEncryptionConfiguration": { "target": "com.amazonaws.athena#CustomerContentEncryptionConfiguration", "traits": { - "smithy.api#documentation": "Specifies the KMS key that is used to encrypt the user's data stores in Athena.
" + "smithy.api#documentation": "Specifies the KMS key that is used to encrypt the user's data stores in Athena. This setting does not apply to Athena SQL workgroups.
" } }, "EnableMinimumEncryptionConfiguration": { @@ -8718,7 +8724,7 @@ "RemoveCustomerContentEncryptionConfiguration": { "target": "com.amazonaws.athena#BoxedBoolean", "traits": { - "smithy.api#documentation": "Removes content encryption configuration for a workgroup.
" + "smithy.api#documentation": "Removes content encryption configuration from an Apache Spark-enabled Athena workgroup.
" } }, "AdditionalConfiguration": { diff --git a/codegen/sdk-codegen/aws-models/auditmanager.2017-07-25.json b/codegen/sdk-codegen/aws-models/auditmanager.2017-07-25.json index f29c0f576dd..8a355823644 100644 --- a/codegen/sdk-codegen/aws-models/auditmanager.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/auditmanager.2017-07-25.json @@ -1121,7 +1121,7 @@ "destination": { "target": "com.amazonaws.auditmanager#S3Url", "traits": { - "smithy.api#documentation": "The destination of the assessment report.
" + "smithy.api#documentation": "The destination bucket where Audit Manager stores assessment reports.
" } } }, @@ -1609,12 +1609,15 @@ { "target": "com.amazonaws.auditmanager#ResourceNotFoundException" }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, { "target": "com.amazonaws.auditmanager#ValidationException" } ], "traits": { - "smithy.api#documentation": "Uploads one or more pieces of evidence to a control in an Audit Manager assessment.\n You can upload manual evidence from any Amazon Simple Storage Service (Amazon S3) bucket by\n specifying the S3 URI of the evidence.
\nYou must upload manual evidence to your S3 bucket before you can upload it to your\n assessment. For instructions, see CreateBucket and PutObject in\n the Amazon Simple Storage Service API Reference.\n
\nThe following restrictions apply to this action:
\nMaximum size of an individual evidence file: 100 MB
\nNumber of daily manual evidence uploads per control: 100
\nSupported file formats: See Supported file types for manual evidence in the Audit Manager User Guide\n
\nFor more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.
", + "smithy.api#documentation": "Adds one or more pieces of evidence to a control in an Audit Manager assessment.
\nYou can import manual evidence from any S3 bucket by specifying the S3 URI of the\n object. You can also upload a file from your browser, or enter plain text in response to a\n risk assessment question.
\nThe following restrictions apply to this action:
\n\n manualEvidence can be only one of the following:\n evidenceFileName, s3ResourcePath, or\n textResponse\n
Maximum size of an individual evidence file: 100 MB
\nNumber of daily manual evidence uploads per control: 100
\nSupported file formats: See Supported file types for manual evidence in the Audit Manager User Guide\n
\nFor more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence", @@ -1792,6 +1795,9 @@ { "target": "com.amazonaws.auditmanager#GetEvidenceByEvidenceFolder" }, + { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrl" + }, { "target": "com.amazonaws.auditmanager#GetEvidenceFolder" }, @@ -2803,7 +2809,7 @@ "type": { "target": "com.amazonaws.auditmanager#ControlType", "traits": { - "smithy.api#documentation": "The type of control, such as a custom control or a standard control.
" + "smithy.api#documentation": "Specifies whether the control is a standard control or a custom control.
" } }, "name": { @@ -3106,7 +3112,7 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "The frequency of evidence collection for the control mapping source.
" + "smithy.api#documentation": "Specifies how often evidence is collected from the control mapping source.
" } }, "troubleshootingText": { @@ -3765,7 +3771,7 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "The frequency of evidence collection for the control mapping source.
" + "smithy.api#documentation": "Specifies how often evidence is collected from the control mapping source.
" } }, "troubleshootingText": { @@ -3910,6 +3916,26 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" } }, + "com.amazonaws.auditmanager#DefaultExportDestination": { + "type": "structure", + "members": { + "destinationType": { + "target": "com.amazonaws.auditmanager#ExportDestinationType", + "traits": { + "smithy.api#documentation": "The destination type, such as Amazon S3.
" + } + }, + "destination": { + "target": "com.amazonaws.auditmanager#S3Url", + "traits": { + "smithy.api#documentation": "The destination bucket where Audit Manager stores exported files.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default s3 bucket where Audit Manager saves the files that you export from evidence finder.
" + } + }, "com.amazonaws.auditmanager#Delegation": { "type": "structure", "members": { @@ -4346,7 +4372,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a custom control in Audit Manager.
", + "smithy.api#documentation": "Deletes a custom control in Audit Manager.
\nWhen you invoke this operation, the custom control is deleted from any frameworks or\n assessments that it’s currently part of. As a result, Audit Manager will stop\n collecting evidence for that custom control in all of your assessments. This includes\n assessments that you previously created before you deleted the custom control.
\nThe framework type, such as a custom framework or a standard framework.
" + "smithy.api#documentation": "Specifies whether the framework is a standard framework or a custom framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" + "smithy.api#documentation": "The compliance type that the framework supports, such as CIS or HIPAA.
" } }, "description": { @@ -4932,7 +4969,7 @@ "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "The sources that Audit Manager collects evidence from for the control.
" + "smithy.api#documentation": "The control data sources where Audit Manager collects evidence from.
" } }, "controlSets": { @@ -5075,7 +5112,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the registration status of an account in Audit Manager.
", + "smithy.api#documentation": "Gets the registration status of an account in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/account/status", @@ -5127,7 +5164,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns an assessment from Audit Manager.
", + "smithy.api#documentation": "Gets information about a specified assessment.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}", @@ -5158,7 +5195,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a framework from Audit Manager.
", + "smithy.api#documentation": "Gets information about a specified framework.
", "smithy.api#http": { "method": "GET", "uri": "/assessmentFrameworks/{frameworkId}", @@ -5219,7 +5256,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the URL of an assessment report in Audit Manager.
", + "smithy.api#documentation": "Gets the URL of an assessment report in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/reports/{assessmentReportId}/url", @@ -5315,7 +5352,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of changelogs from Audit Manager.
", + "smithy.api#documentation": "Gets a list of changelogs from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/changelogs", @@ -5415,7 +5452,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a control from Audit Manager.
", + "smithy.api#documentation": "Gets information about a specified control.
", "smithy.api#http": { "method": "GET", "uri": "/controls/{controlId}", @@ -5445,7 +5482,7 @@ "control": { "target": "com.amazonaws.auditmanager#Control", "traits": { - "smithy.api#documentation": " The name of the control that the GetControl API returned.
The details of the control that the GetControl API returned.
Returns a list of delegations from an audit owner to a delegate.
", + "smithy.api#documentation": "Gets a list of delegations from an audit owner to a delegate.
", "smithy.api#http": { "method": "GET", "uri": "/delegations", @@ -5551,7 +5588,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns evidence from Audit Manager.
", + "smithy.api#documentation": "Gets information about a specified evidence item.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}", @@ -5582,7 +5619,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns all evidence from a specified evidence folder in Audit Manager.
", + "smithy.api#documentation": "Gets all evidence from a specified evidence folder in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence", @@ -5661,6 +5698,73 @@ "smithy.api#output": {} } }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ThrottlingException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a presigned Amazon S3 URL that can be used to upload a file as manual\n evidence. For instructions on how to use this operation, see Upload a file from your browser in the Audit Manager User\n Guide.
\nThe following restrictions apply to this operation:
\nMaximum size of an individual evidence file: 100 MB
\nNumber of daily manual evidence uploads per control: 100
\nSupported file formats: See Supported file types for manual evidence in the Audit Manager User Guide\n
\nFor more information about Audit Manager service restrictions, see Quotas and\n restrictions for Audit Manager.
", + "smithy.api#http": { + "method": "GET", + "uri": "/evidenceFileUploadUrl", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlRequest": { + "type": "structure", + "members": { + "fileName": { + "target": "com.amazonaws.auditmanager#ManualEvidenceLocalFileName", + "traits": { + "smithy.api#documentation": "The file that you want to upload. For a list of supported file formats, see Supported file types for manual evidence in the Audit Manager\n User Guide.
", + "smithy.api#httpQuery": "fileName", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.auditmanager#GetEvidenceFileUploadUrlResponse": { + "type": "structure", + "members": { + "evidenceFileName": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the uploaded manual evidence file that the presigned URL was generated\n for.
" + } + }, + "uploadUrl": { + "target": "com.amazonaws.auditmanager#NonEmptyString", + "traits": { + "smithy.api#documentation": "The presigned URL that was generated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.auditmanager#GetEvidenceFolder": { "type": "operation", "input": { @@ -5684,7 +5788,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns an evidence folder from the specified assessment in Audit Manager.\n
", + "smithy.api#documentation": "Gets an evidence folder from a specified assessment in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}", @@ -5761,7 +5865,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the evidence folders from a specified assessment in Audit Manager.\n
", + "smithy.api#documentation": "Gets the evidence folders from a specified assessment in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders", @@ -5797,7 +5901,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of evidence folders that are associated with a specified control in an\n Audit Manager assessment.
", + "smithy.api#documentation": "Gets a list of evidence folders that are associated with a specified control in an\n Audit Manager assessment.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}", @@ -6110,7 +6214,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the name of the delegated Amazon Web Services administrator account for the\n organization.
", + "smithy.api#documentation": "Gets the name of the delegated Amazon Web Services administrator account for a specified\n organization.
", "smithy.api#http": { "method": "GET", "uri": "/account/organizationAdminAccount", @@ -6165,7 +6269,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of all of the Amazon Web Services that you can choose to include\n in your assessment. When you create an assessment, specify which of these services you want to include to\n narrow the assessment's scope.
", + "smithy.api#documentation": "Gets a list of all of the Amazon Web Services that you can choose to include in\n your assessment. When you create an assessment, specify which of these services you want to include to\n narrow the assessment's scope.
", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -6211,7 +6315,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the settings for the specified Amazon Web Services account.
", + "smithy.api#documentation": "Gets the settings for a specified Amazon Web Services account.
", "smithy.api#http": { "method": "GET", "uri": "/settings/{attribute}", @@ -6393,6 +6497,18 @@ "traits": { "smithy.api#enumValue": "SELECT_FROM_LIST" } + }, + "UPLOAD_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPLOAD_FILE" + } + }, + "INPUT_TEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INPUT_TEXT" + } } } }, @@ -6678,7 +6794,7 @@ "frameworkMetadataList": { "target": "com.amazonaws.auditmanager#FrameworkMetadataList", "traits": { - "smithy.api#documentation": "The list of metadata objects for the framework.
" + "smithy.api#documentation": " A list of metadata that the ListAssessmentFrameworks API returns for each\n framework.
The metadata that's associated with the assessment.
" + "smithy.api#documentation": "The metadata that the ListAssessments API returns for each\n assessment.
The list of control metadata objects that the ListControls API returned.\n
A list of metadata that the ListControls API returns for each\n control.
The Amazon S3 URL that points to a manual evidence object.
" + "smithy.api#documentation": "The S3 URL of the object that's imported as manual evidence.
" + } + }, + "textResponse": { + "target": "com.amazonaws.auditmanager#ManualEvidenceTextResponse", + "traits": { + "smithy.api#documentation": "The plain text response that's entered and saved as manual evidence.
" + } + }, + "evidenceFileName": { + "target": "com.amazonaws.auditmanager#ManualEvidenceLocalFileName", + "traits": { + "smithy.api#documentation": "The name of the file that's uploaded as manual evidence. This name is populated using\n the evidenceFileName value from the \n GetEvidenceFileUploadUrl\n API response.
Evidence that's uploaded to Audit Manager manually.
" + "smithy.api#documentation": " Evidence that's manually added to a control in Audit Manager.\n manualEvidence can be one of the following: evidenceFileName,\n s3ResourcePath, or textResponse.
The default storage destination for assessment reports.
" + "smithy.api#documentation": "The default S3 destination bucket for storing assessment reports.
" } }, "defaultProcessOwners": { @@ -7992,6 +8146,12 @@ "traits": { "smithy.api#documentation": "The deregistration policy for your Audit Manager data. You can\n use this attribute to determine how your data is handled when you deregister Audit Manager.
" } + }, + "defaultExportDestination": { + "target": "com.amazonaws.auditmanager#DefaultExportDestination", + "traits": { + "smithy.api#documentation": "The default S3 destination bucket for storing evidence finder exports.
" + } } }, "traits": { @@ -8150,18 +8310,18 @@ "keywordInputType": { "target": "com.amazonaws.auditmanager#KeywordInputType", "traits": { - "smithy.api#documentation": "The input method for the keyword.
" + "smithy.api#documentation": "The input method for the keyword.
\n\n SELECT_FROM_LIST is used when mapping a data source for automated\n evidence.
When keywordInputType is SELECT_FROM_LIST, a\n keyword must be selected to collect automated evidence. For example, this\n keyword can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call.
\n UPLOAD_FILE and INPUT_TEXT are only used when mapping a\n data source for manual evidence.
When keywordInputType is UPLOAD_FILE, a file must\n be uploaded as manual evidence.
When keywordInputType is INPUT_TEXT, text must be\n entered as manual evidence.
The value of the keyword that's used when mapping a control data source. For example,\n this can be a CloudTrail event name, a rule name for Config, a\n Security Hub control, or the name of an Amazon Web Services API call.
\nIf you’re mapping a data source to a rule in Config, the\n keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the\n keywordValue. You can find the rule identifier from the list of Config managed rules.
Managed rule name: s3-bucket-acl-prohibited\n
\n\n keywordValue: S3_BUCKET_ACL_PROHIBITED\n
For custom rules, you form the keywordValue\n by adding the Custom_ prefix to the rule name. This prefix distinguishes\n the rule from a managed rule.
Custom rule name: my-custom-config-rule
\n\n keywordValue: Custom_my-custom-config-rule\n
For service-linked rules, you form the\n keywordValue by adding the Custom_ prefix to the rule\n name. In addition, you remove the suffix ID that appears at the end of the rule\n name.
Service-linked rule name:\n CustomRuleForAccount-conformance-pack-szsm1uv0w
\n\n keywordValue:\n Custom_CustomRuleForAccount-conformance-pack\n
Service-linked rule name:\n OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
\n\n keywordValue:\n Custom_OrgConfigRule-s3-bucket-versioning-enabled\n
The value of the keyword that's used when mapping a control data source. For example,\n this can be a CloudTrail event name, a rule name for Config, a\n Security Hub control, or the name of an Amazon Web Services API call.
\nIf you’re mapping a data source to a rule in Config, the\n keywordValue that you specify depends on the type of rule:
For managed rules, you can use the rule identifier as the\n keywordValue. You can find the rule identifier from the list of Config managed rules. For some\n rules, the rule identifier is different from the rule name. For example, the rule\n name restricted-ssh has the following rule identifier:\n INCOMING_SSH_DISABLED. Make sure to use the rule identifier, not the\n rule name.
Keyword example for managed rules:
\nManaged rule name: s3-bucket-acl-prohibited\n
\n\n keywordValue: S3_BUCKET_ACL_PROHIBITED\n
For custom rules, you form the keywordValue\n by adding the Custom_ prefix to the rule name. This prefix distinguishes\n the custom rule from a managed rule.
Keyword example for custom rules:
\nCustom rule name: my-custom-config-rule
\n\n keywordValue: Custom_my-custom-config-rule\n
For service-linked rules, you form the\n keywordValue by adding the Custom_ prefix to the rule\n name. In addition, you remove the suffix ID that appears at the end of the rule name.
Keyword examples for service-linked rules:
\nService-linked rule name:\n CustomRuleForAccount-conformance-pack-szsm1uv0w
\n\n keywordValue:\n Custom_CustomRuleForAccount-conformance-pack\n
Service-linked rule name:\n OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
\n\n keywordValue:\n Custom_OrgConfigRule-s3-bucket-versioning-enabled\n
The keywordValue is case sensitive. If you enter a value incorrectly, Audit Manager might not recognize the data source mapping. As a result, you might not\n successfully collect evidence from that data source as intended.
Keep in mind the following requirements, depending on the data source type that\n you're using.
\nFor Config:
\nFor managed rules, make sure that the keywordValue is the rule identifier in\n ALL_CAPS_WITH_UNDERSCORES. For example,\n CLOUDWATCH_LOG_GROUP_ENCRYPTED. For accuracy, we recommend\n that you reference the list of supported Config managed rules.
For custom rules, make sure that the keywordValue has the Custom_\n prefix followed by the custom rule name. The format of the custom rule name\n itself may vary. For accuracy, we recommend that you visit the Config console to\n verify your custom rule name.
For Security Hub: The format varies for Security Hub control names.\n For accuracy, we recommend that you reference the list of supported\n Security Hub controls.
\nFor Amazon Web Services API calls: Make sure that the keywordValue\n is written as serviceprefix_ActionName. For example,\n iam_ListGroups. For accuracy, we recommend that you reference the\n list of supported\n API calls.
For CloudTrail: Make sure that the keywordValue is written\n as serviceprefix_ActionName. For example,\n cloudtrail_StartLogging. For accuracy, we recommend that you\n review the Amazon Web Service prefix and action names in the Service Authorization Reference.
The keyword to search for in CloudTrail logs, Config rules,\n Security Hub checks, and Amazon Web Services API names.
\nTo learn more about the supported keywords that you can use when mapping a control data\n source, see the following pages in the Audit Manager User\n Guide:
\nA keyword that relates to the control data source.
\nFor manual evidence, this keyword indicates if the manual evidence is a file or\n text.
\nFor automated evidence, this keyword identifies a specific CloudTrail event,\n Config rule, Security Hub control, or Amazon Web Services API name.
\nTo learn more about the supported keywords that you can use when mapping a control data\n source, see the following pages in the Audit Manager User\n Guide:
\nThe default storage destination for assessment reports.
" + "smithy.api#documentation": "The default S3 destination bucket for storing assessment reports.
" } }, "defaultProcessOwners": { @@ -9273,6 +9433,12 @@ "traits": { "smithy.api#documentation": "The deregistration policy for your Audit Manager data. You can\n use this attribute to determine how your data is handled when you deregister Audit Manager.
" } + }, + "defaultExportDestination": { + "target": "com.amazonaws.auditmanager#DefaultExportDestination", + "traits": { + "smithy.api#documentation": "The default S3 destination bucket for storing evidence finder exports.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json index 850567a013b..58e014fac1f 100644 --- a/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json +++ b/codegen/sdk-codegen/aws-models/cloudformation.2010-05-15.json @@ -206,7 +206,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates.\n For more information, see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use\n SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Activates a public third-party extension, making it available for use in stack templates. For more information,\n see Using public\n extensions in the CloudFormation User Guide.
\nOnce you have activated a public third-party extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see\n Configuring extensions at\n the account level in the CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -216,37 +216,37 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The extension type.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The Amazon Resource Name (ARN) of the public extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The ID of the extension publisher.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName,\n Type, and PublisherId.
The name of the extension.
\nConditional: You must specify PublicTypeArn, or TypeName, Type, and\n PublisherId.
An alias to assign to the public extension, in this account and Region. If you specify an\n alias for the extension, CloudFormation treats the alias as the extension type name\n within this account and Region. You must use the alias to refer to the extension in your\n templates, API calls, and CloudFormation console.
\nAn extension alias must be unique within a given account and Region. You can activate the\n same public resource multiple times in the same account and Region, using different type name\n aliases.
" + "smithy.api#documentation": "An alias to assign to the public extension, in this account and Region. If you specify an alias for the\n extension, CloudFormation treats the alias as the extension type name within this account and Region. You\n must use the alias to refer to the extension in your templates, API calls, and CloudFormation\n console.
\nAn extension alias must be unique within a given account and Region. You can activate the same public resource\n multiple times in the same account and Region, using different type name aliases.
" } }, "AutoUpdate": { "target": "com.amazonaws.cloudformation#AutoUpdate", "traits": { - "smithy.api#documentation": "Whether to automatically update the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions\n released by the publisher must be manually updated.
\nThe default is true.
Whether to automatically update the extension in this account and Region when a new minor\n version is published by the extension publisher. Major versions released by the publisher must be manually\n updated.
\nThe default is true.
Manually updates a previously-activated type to a new major or minor version, if\n available. You can also use this parameter to update the value of\n AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major\n version, if one is available.
\n MINOR: CloudFormation updates the extension to the newest minor\n version, if one is available.
Manually updates a previously-activated type to a new major or minor version, if available. You can also use\n this parameter to update the value of AutoUpdate.
\n MAJOR: CloudFormation updates the extension to the newest major version, if one is\n available.
\n MINOR: CloudFormation updates the extension to the newest minor version, if one is\n available.
The major version of this extension you want to activate, if multiple major versions are\n available. The default is the latest major version. CloudFormation uses the latest\n available minor version of the major version selected.
\nYou can specify MajorVersion or VersionBump, but not\n both.
The major version of this extension you want to activate, if multiple major versions are available. The default\n is the latest major version. CloudFormation uses the latest available minor version of\n the major version selected.
\nYou can specify MajorVersion or VersionBump, but not both.
The Amazon Resource Name (ARN) of the activated extension, in this account and\n Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the activated extension, in this account and Region.
" } } }, @@ -364,7 +364,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the\n CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at the account level in the\n CloudFormation User Guide.
" + "smithy.api#documentation": "Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.
\nFor more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsError": { @@ -420,19 +420,19 @@ "Errors": { "target": "com.amazonaws.cloudformation#BatchDescribeTypeConfigurationsErrors", "traits": { - "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified\n configurations.
" + "smithy.api#documentation": "A list of information concerning any errors generated during the setting of the specified configurations.
" } }, "UnprocessedTypeConfigurations": { "target": "com.amazonaws.cloudformation#UnprocessedTypeConfigurations", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could\n not process for any reason.
" + "smithy.api#documentation": "A list of any of the specified extension configurations that CloudFormation could not process for any\n reason.
" } }, "TypeConfigurations": { "target": "com.amazonaws.cloudformation#TypeConfigurationDetailsList", "traits": { - "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation\n registry.
" + "smithy.api#documentation": "A list of any of the specified extension configurations from the CloudFormation registry.
" } } }, @@ -500,7 +500,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels an update on the specified stack. If the call completes successfully, the stack\n rolls back the update and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update\n and reverts to the previous stack configuration.
\nYou can cancel only stacks that are in the UPDATE_IN_PROGRESS state.
If you don't pass a parameter to StackName, the API returns a response that\n describes all resources in the account.
The IAM policy below can be added to IAM policies when you\n want to limit resource-level permissions and avoid returning a response when no parameter is\n sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }\n
The name or the unique stack ID that's associated with the stack.
", + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes\n all resources in the account.
The IAM policy below can be added to\n IAM policies when you want to limit resource-level permissions and\n avoid returning a response when no parameter is sent in the request:
\n\n { \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\":\n \"arn:aws:cloudformation:*:*:stack/*/*\" }] }\n
The name or the unique stack ID that's associated with the stack.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CancelUpdateStack request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n cancel an update on a stack with the same name. You might retry CancelUpdateStack\n requests to ensure that CloudFormation successfully received them.
A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to cancel an update on a stack with the same\n name. You might retry CancelUpdateStack requests to ensure that CloudFormation successfully received\n them.
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at \n docs.aws.amazon.com\n .
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably\n and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build\n highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
\nWith CloudFormation, you declare all your resources and dependencies in a template file. The template\n defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member\n resources of the stack together and manages all dependencies between the resources for you.
\nFor more information about CloudFormation, see the CloudFormation product page.
\nCloudFormation makes use of other Amazon Web Services products. If you need additional technical information\n about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
", "smithy.api#title": "AWS CloudFormation", "smithy.api#xmlNamespace": { "uri": "http://cloudformation.amazonaws.com/doc/2010-05-15/" @@ -2369,7 +2369,7 @@ } ], "traits": { - "smithy.api#documentation": "For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues\n rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of\n the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can\n return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and\n then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all changes after a failed stack update. For example, you might have a\n stack that's rolling back to an old database instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was deleted, it assumes\n that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the\n UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the\n error and continue the rollback. By continuing the rollback, you can return your stack to a working state\n (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.
A stack goes into the UPDATE_ROLLBACK_FAILED state when CloudFormation can't roll back all\n changes after a failed stack update. For example, you might have a stack that's rolling back to an old database\n instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was\n deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update\n rollback to fail.
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the\n parent stack (the stack that contains the AWS::CloudFormation::Stack\n resource).
The name or the unique ID of the stack that you want to continue rolling back.
\nDon't specify the name of a nested stack (a stack that was created by using the\n AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that\n contains the AWS::CloudFormation::Stack resource).
The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n CloudFormation assumes to roll back the stack. CloudFormation uses the\n role's credentials to make calls on your behalf. CloudFormation always uses this role\n for all future operations on the stack. Provided that users have permission to operate on the\n stack, CloudFormation uses this role even if the users don't have permission to pass\n it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to roll back the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" } }, "ResourcesToSkip": { "target": "com.amazonaws.cloudformation#ResourcesToSkip", "traits": { - "smithy.api#documentation": "A list of the logical IDs of the resources that CloudFormation skips during the\n continue update rollback operation. You can specify only resources that are in the\n UPDATE_FAILED state because a rollback failed. You can't specify resources that\n are in the UPDATE_FAILED state for other reasons, for example, because an update\n was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't\n successfully roll back. We recommend that you troubleshoot resources before skipping them. CloudFormation sets the\n status of the specified resources to UPDATE_COMPLETE and continues to roll back\n the stack. After the rollback is complete, the state of the skipped resources will be\n inconsistent with the state of the resources in the stack template. Before performing\n another stack update, you must update the stack or resources to be consistent with each\n other. If you don't, subsequent stack updates might fail, and the stack will become\n unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For\n example, a failed resource update might cause dependent resources to fail. In this case, it\n might not be necessary to skip the dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a\n stack resource (Type: AWS::CloudFormation::Stack) in the\n ResourcesToSkip list, then its corresponding embedded stack must be in one of\n the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or\n DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the\n parent stack. For an example of a continue update rollback operation with nested stacks, see\n Using ResourcesToSkip to recover a nested stacks hierarchy.
\nA list of the logical IDs of the resources that CloudFormation skips during the continue update rollback\n operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed.\n You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because\n an update was canceled. To check why a resource update failed, use the DescribeStackResources\n action, and view the resource status reason.
Specify this property to skip rolling back resources that CloudFormation can't successfully roll back.\n We recommend that you \n troubleshoot resources before skipping them. CloudFormation sets the status of the specified\n resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the\n state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before\n performing another stack update, you must update the stack or resources to be consistent with each other. If you\n don't, subsequent stack updates might fail, and the stack will become unrecoverable.
Specify the minimum number of resources required to successfully roll back your stack. For example, a failed\n resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the\n dependent resources.
\nTo skip resources that are part of nested stacks, use the following format:\n NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource\n (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding\n embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE,\n or DELETE_FAILED.
Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an\n example of a continue update rollback operation with nested stacks, see Using\n ResourcesToSkip to recover a nested stacks hierarchy.
\nA unique identifier for this ContinueUpdateRollback request. Specify this\n token if you plan to retry requests so that CloudFormationknows that you're not attempting\n to continue the rollback to a stack with the same name. You might retry\n ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to\n retry requests so that CloudFormation knows that you're not attempting to continue the rollback to a stack with\n the same name. You might retry ContinueUpdateRollback requests to ensure that CloudFormation\n successfully received them.
Creates a list of changes that will be applied to a stack so that you can review the\n changes before executing them. You can create a change set for a stack that doesn't exist or\n an existing stack. If you create a change set for a stack that doesn't exist, the change set\n shows all of the resources that CloudFormation will create. If you create a change set for\n an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand\n which resources CloudFormation will create or change, and how it will change resources in\n an existing stack, before you create or update a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType\n parameter, specify CREATE. To create a change set for an existing stack, specify\n UPDATE for the ChangeSetType parameter. To create a change set for\n an import operation, specify IMPORT for the ChangeSetType parameter.\n After the CreateChangeSet call successfully completes, CloudFormation starts\n creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set\n by using the ExecuteChangeSet action. CloudFormation doesn't make\n changes until you execute the change set.
\nTo create a change set for the entire stack hierarchy, set\n IncludeNestedStacks to True.
Creates a list of changes that will be applied to a stack so that you can review the changes before executing\n them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for\n a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you\n create a change set for an existing stack, CloudFormation compares the stack's information with the information\n that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update\n a stack.
\nTo create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify\n CREATE. To create a change set for an existing stack, specify UPDATE for the\n ChangeSetType parameter. To create a change set for an import operation, specify IMPORT\n for the ChangeSetType parameter. After the CreateChangeSet call successfully completes,\n CloudFormation starts creating the change set. To check the status of the change set or to review it, use the\n DescribeChangeSet action.
When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. CloudFormation doesn't make changes until you execute the change\n set.
\nTo create a change set for the entire stack hierarchy, set IncludeNestedStacks to\n True.
The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the change set by comparing this stack's information with the\n information that you submit, such as a modified template or different parameter input\n values.
", + "smithy.api#documentation": "The name or the unique ID of the stack for which you are creating a change set. CloudFormation generates the\n change set by comparing this stack's information with the information that you submit, such as a modified template or\n different parameter input values.
", "smithy.api#required": {} } }, "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "A structure that contains the body of the revised template, with a minimum length of 1\n byte and a maximum length of 51,200 bytes. CloudFormation generates the change set by\n comparing this template with the template of the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length\n of 51,200 bytes. CloudFormation generates the change set by comparing this template with the template of the\n stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
The location of the file that contains the revised template. The URL must point to a\n template (max size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems\n Manager document. CloudFormation generates the change set by comparing this template with\n the stack that you specified.
\nConditional: You must specify only TemplateBody or\n TemplateURL.
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800\n bytes) that's located in an Amazon S3 bucket or a Systems Manager document. CloudFormation generates the\n change set by comparing this template with the stack that you specified.
\nConditional: You must specify only TemplateBody or TemplateURL.
Whether to reuse the template that's associated with the stack to create the change\n set.
" + "smithy.api#documentation": "Whether to reuse the template that's associated with the stack to create the change set.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the change\n set. For more information, see the Parameter data type.
A list of Parameter structures that specify input parameters for the change set. For more\n information, see the Parameter data type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying\n one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns\n an InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating\n change sets has no effect.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create or update the stack directly\n from the template using the CreateStack or UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom processing on\n templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging\n IAM resources in CloudFormation templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.
\nThis capacity doesn't apply to creating change sets, and specifying it when creating change sets has no\n effect.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create or update the stack directly from the template using the CreateStack or\n UpdateStack action, and specifying this capability.
\nFor more information about macros, see Using CloudFormation macros to perform custom processing on templates.
\nThe template resource types that you have permissions to work with if you execute this\n change set, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the\n stack update fails. By default, CloudFormation grants permissions to all resource types.\n Identity and Access Management (IAM) uses this parameter for condition keys in\n IAM policies for CloudFormation. For more information, see Controlling access with Identity and Access Management in the CloudFormation User Guide.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with if you execute this change set, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for condition keys in IAM policies for CloudFormation. For more information,\n see Controlling access\n with Identity and Access Management in the CloudFormation User Guide.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n CloudFormation assumes when executing the change set. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation uses this role for all future\n operations on the stack. Provided that users have permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure that\n the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation\n assumes when executing the change set. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation uses this role for all future operations on the stack. Provided that users have permission to\n operate on the stack, CloudFormation uses this role even if the users don't have permission to pass it. Ensure\n that the role grants least permission.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the stack. If\n no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics\n that CloudFormation associates with the stack. To remove all associated notification\n topics, specify an empty list.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that CloudFormation\n associates with the stack. To remove all associated notification topics, specify an empty list.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these\n tags to resources in the stack. You can specify a maximum of 50 tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to resources in the\n stack. You can specify a maximum of 50 tags.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetName", "traits": { - "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are\n associated with the specified stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens.\n It must start with an alphabetical character and can't exceed 128 characters.
", + "smithy.api#documentation": "The name of the change set. The name must be unique among all change sets that are associated with the specified\n stack.
\nA change set name can contain only alphanumeric, case sensitive characters, and hyphens. It must start with an\n alphabetical character and can't exceed 128 characters.
", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n create another change set with the same name. You might retry CreateChangeSet\n requests to ensure that CloudFormation successfully received them.
A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to create another change set with the same name.\n You might retry CreateChangeSet requests to ensure that CloudFormation successfully received\n them.
The type of change set operation. To create a change set for a new stack, specify\n CREATE. To create a change set for an existing stack, specify\n UPDATE. To create a change set for an import operation, specify\n IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a\n unique stack ID, but no template or resources. The stack will be in the \n REVIEW_IN_PROGRESS\n state until you execute the change set.
By default, CloudFormation specifies UPDATE. You can't use the\n UPDATE type to create a change set for a new stack or the CREATE\n type to create a change set for an existing stack.
The type of change set operation. To create a change set for a new stack, specify CREATE. To create\n a change set for an existing stack, specify UPDATE. To create a change set for an import operation,\n specify IMPORT.
If you create a change set for a new stack, CloudFormation creates a stack with a unique stack ID, but no\n template or resources. The stack will be in the REVIEW_IN_PROGRESS state\n until you execute the change set.
\nBy default, CloudFormation specifies UPDATE. You can't use the UPDATE type to\n create a change set for a new stack or the CREATE type to create a change set for an existing\n stack.
Creates a change set for the all nested stacks specified in the template. The default\n behavior of this action is set to False. To include nested sets in a change set,\n specify True.
Creates a change set for the all nested stacks specified in the template. The default behavior of this action is\n set to False. To include nested sets in a change set, specify True.
Determines what action will be taken if stack creation fails. If this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
For nested stacks, when the OnStackFailure parameter is set to DELETE for the change\n set for the parent stack, any failure in a child stack will cause the parent stack creation to fail and all stacks to\n be deleted.
Creates a stack as specified in the template. After the call completes successfully, the\n stack creation starts. You can check the status of the stack through the DescribeStacksoperation.
" + "smithy.api#documentation": "Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.\n You can check the status of the stack through the DescribeStacks operation.
" } }, "com.amazonaws.cloudformation#CreateStackInput": { @@ -2603,104 +2609,104 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "The name that's associated with the stack. The name must be unique in the Region in which\n you are creating the stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It\n must start with an alphabetical character and can't be longer than 128 characters.
\nThe name that's associated with the stack. The name must be unique in the Region in which you are creating the\n stack.
\nA stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an\n alphabetical character and can't be longer than 128 characters.
\nStructure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information, go to Template anatomy in\n the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template anatomy in the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document.\n For more information, go to the Template anatomy in\n the CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the\n TemplateURL parameter, but not both.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify either the TemplateBody or the TemplateURL parameter,\n but not both.
A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
Set to true to disable rollback of the stack if stack creation failed. You\n can specify either DisableRollback or OnFailure, but not\n both.
Default: false\n
Set to true to disable rollback of the stack if stack creation failed. You can specify either\n DisableRollback or OnFailure, but not both.
Default: false\n
The rollback triggers for CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" } }, "TimeoutInMinutes": { "target": "com.amazonaws.cloudformation#TimeoutMinutes", "traits": { - "smithy.api#documentation": "The amount of time that can pass before the stack status becomes CREATE_FAILED; if\n DisableRollback is not set or is set to false, the stack will be\n rolled back.
The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback\n is not set or is set to false, the stack will be rolled back.
The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related\n events. You can find your Amazon SNS topic ARNs using the Amazon SNS console\n or your Command Line Interface (CLI).
" + "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your\n Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying\n one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually creating the stack. If your stack template contains one or more macros,\n and you choose to create a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros\n and nested stacks, you must create the stack directly from the\n template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can\n update the function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation macros to perform custom processing on\n templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to create the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we recommend that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging\n IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually creating the stack. If your stack template contains one or more macros, and you choose\n to create a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.
\nIf you want to create a stack from a stack template that contains macros and nested\n stacks, you must create the stack directly from the template using this capability.
\nYou should only create stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation macros\n to perform custom processing on templates.
\nThe template resource types that you have permissions to work with for this create stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance. Use the following syntax to describe template\n resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources),\n Custom::logical_ID\n (for a specific custom resource),\n AWS::service_name::* (for all resources of a particular\n Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack\n creation fails. By default, CloudFormation grants permissions to all resource types.\n Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with for this create stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the\n following syntax to describe template resource types: AWS::* (for all Amazon Web Services resources),\n Custom::* (for all custom resources), Custom::logical_ID\n (for a specific custom resource), AWS::service_name::* (for all resources\n of a particular Amazon Web Services service), and\n AWS::service_name::resource_logical_ID\n (for a specific Amazon Web Services resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n CloudFormation assumes to create the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. Provided that users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to create the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" } }, "OnFailure": { "target": "com.amazonaws.cloudformation#OnFailure", "traits": { - "smithy.api#documentation": "Determines what action will be taken if stack creation fails. This must be one of:\n DO_NOTHING, ROLLBACK, or DELETE. You can specify\n either OnFailure or DisableRollback, but not both.
Default: ROLLBACK\n
Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING,\n ROLLBACK, or DELETE. You can specify either OnFailure or\n DisableRollback, but not both.
Default: ROLLBACK\n
Structure containing the stack policy body. For more information, go to \n Prevent Updates to Stack Resources in the CloudFormation User Guide. You\n can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an S3 bucket in the same Region as the stack. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Key-value pairs to associate with this stack. CloudFormation also propagates these\n tags to the resources created in the stack. A maximum number of 50 tags can be\n specified.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to the resources\n created in the stack. A maximum number of 50 tags can be specified.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this CreateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to\n create a stack with the same name. You might retry CreateStack requests to ensure\n that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this CreateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to create a stack with the same name. You might retry\n CreateStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Whether to enable termination protection on the specified stack. If a user attempts to\n delete a stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.\n Termination protection is deactivated on stacks by default.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with\n termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the\n CloudFormation User Guide. Termination protection is deactivated on stacks by default.
\nFor nested stacks, termination protection is set\n on the root stack and can't be changed directly on the nested stack.
" } } }, @@ -3037,7 +3043,7 @@ } ], "traits": { - "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and\n Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation.\n This includes stack update operations where the stack template includes the extension, even if\n no updates are being made to the extension. In addition, deactivated extensions aren't\n automatically updated if a new version of the extension is released.
", + "smithy.api#documentation": "Deactivates a public extension that was previously activated in this account and Region.
\nOnce deactivated, an extension can't be used in any CloudFormation operation. This includes stack\n update operations where the stack template includes the extension, even if no updates are being made to the\n extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is\n released.
", "smithy.api#idempotent": {} } }, @@ -3047,19 +3053,19 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The type name of the extension, in this account and Region. If you specified a type name\n alias when enabling the extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The type name of the extension, in this account and Region. If you specified a type name alias when enabling the\n extension, use the type name alias.
\nConditional: You must specify either Arn, or TypeName and Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The extension type.
\nConditional: You must specify either Arn, or TypeName and Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nConditional: You must specify either Arn, or TypeName and Type.
Deletes the specified change set. Deleting change sets ensures that no one executes the\n wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change\n set.
\nIf IncludeNestedStacks specifies True during the creation of the\n nested change set, then DeleteChangeSet will delete all change sets that belong\n to the stacks hierarchy and will also delete all change sets for nested stacks with the status\n of REVIEW_IN_PROGRESS.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
\nIf the call successfully completes, CloudFormation successfully deleted the change set.
\nIf IncludeNestedStacks specifies True during the creation of the nested change set,\n then DeleteChangeSet will delete all change sets that belong to the stacks hierarchy and will also\n delete all change sets for nested stacks with the status of REVIEW_IN_PROGRESS.
If you specified the name of a change set to delete, specify the stack name or Amazon\n Resource Name (ARN) that's associated with it.
" + "smithy.api#documentation": "If you specified the name of a change set to delete, specify the stack name or Amazon Resource Name (ARN) that's\n associated with it.
" } } }, @@ -3135,7 +3141,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts.\n Deleted stacks don't show up in the DescribeStacks operation if the deletion\n has been completed successfully.
" + "smithy.api#documentation": "Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't\n show up in the DescribeStacks operation if the deletion has been completed successfully.
" } }, "com.amazonaws.cloudformation#DeleteStackInput": { @@ -3151,19 +3157,19 @@ "RetainResources": { "target": "com.amazonaws.cloudformation#RetainResources", "traits": { - "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that\n are associated with the resources you want to retain. During deletion, CloudFormation\n deletes the stack but doesn't delete the retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3\n bucket, but you want to delete the stack.
" + "smithy.api#documentation": "For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the\n resources you want to retain. During deletion, CloudFormation deletes the stack but doesn't delete the\n retained resources.
Retaining resources is useful when you can't delete a resource, such as a non-empty S3 bucket, but you want to\n delete the stack.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n CloudFormation assumes to delete the stack. CloudFormation uses the role's\n credentials to make calls on your behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that's generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to delete the stack. CloudFormation uses the role's credentials to make calls on your\n behalf.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that's generated from your user\n credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this DeleteStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to\n delete a stack with the same name. You might retry DeleteStack requests to ensure\n that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry\n DeleteStack requests to ensure that CloudFormation successfully received them.
All events initiated by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension\n versions cannot be used in CloudFormation operations.
To deregister an entire extension, you must individually deregister all active versions of\n that extension. If an extension has only a single active version, deregistering that version\n results in the extension itself being deregistered and marked as deprecated in the\n registry.
\nYou can't deregister the default version of an extension if there are other active version\n of that extension. If you do deregister the default version of an extension, the extension\n type itself is deregistered as well and marked as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", + "smithy.api#documentation": "Marks an extension or extension version as DEPRECATED in the CloudFormation registry,\n removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation\n operations.
To deregister an entire extension, you must individually deregister all active versions of that extension. If an\n extension has only a single active version, deregistering that version results in the extension itself being\n deregistered and marked as deprecated in the registry.
\nYou can't deregister the default version of an extension if there are other active version of that extension. If\n you do deregister the default version of an extension, the extension type itself is deregistered as well and marked\n as deprecated.
\nTo view the deprecation status of an extension or extension version, use DescribeType.
", "smithy.api#idempotent": {} } }, @@ -3403,25 +3409,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" } } }, @@ -3445,7 +3451,7 @@ "target": "com.amazonaws.cloudformation#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks\n that you can create in your account. For more information about account limits, see CloudFormation Quotas in the CloudFormation User Guide.
", + "smithy.api#documentation": "Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in\n your account. For more information about account limits, see CloudFormation Quotas in the\n CloudFormation User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -3474,13 +3480,13 @@ "AccountLimits": { "target": "com.amazonaws.cloudformation#AccountLimitList", "traits": { - "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and\n their values.
" + "smithy.api#documentation": "An account limit structure that contain a list of CloudFormation account limits and their values.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If\n no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page\n exists, this value is null.
" } } }, @@ -3503,7 +3509,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will\n make if you execute the change set. For more information, see Updating\n Stacks Using Change Sets in the CloudFormation User Guide.
", + "smithy.api#documentation": "Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the\n change set. For more information, see Updating Stacks Using Change\n Sets in the CloudFormation User Guide.
", "smithy.api#suppress": [ "WaitableTraitInvalidErrorType" ], @@ -3557,7 +3563,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.
" + "smithy.api#documentation": "Returns hook-related information for the change set and a list of changes that CloudFormation makes when you\n run the change set.
" } }, "com.amazonaws.cloudformation#DescribeChangeSetHooksInput": { @@ -3573,19 +3579,19 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the\n change set you want to describe.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or stack ID (ARN) of the change set you want\n to describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string, provided by the DescribeChangeSetHooks response output, that\n identifies the next page of information that you want to retrieve.
A string, provided by the DescribeChangeSetHooks response output, that identifies the next page of\n information that you want to retrieve.
If specified, lists only the hooks related to the specified\n LogicalResourceId.
If specified, lists only the hooks related to the specified LogicalResourceId.
If you specified the name of a change set, specify the stack name or ID (ARN) of the\n change set you want to describe.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to\n describe.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that\n identifies the next page of information that you want to retrieve.
" + "smithy.api#documentation": "A string (provided by the DescribeChangeSet response output) that identifies the next page of\n information that you want to retrieve.
" } } }, @@ -3707,7 +3713,7 @@ "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that describes the input parameters and their\n values used to create the change set. For more information, see the Parameter data type.
A list of Parameter structures that describes the input parameters and their values used to create\n the change set. For more information, see the Parameter data type.
If the change set execution status is AVAILABLE, you can execute the change\n set. If you can't execute the change set, the status indicates why. For example, a change set\n might be in an UNAVAILABLE state because CloudFormation is still creating it\n or in an OBSOLETE state because the stack was already updated.
If the change set execution status is AVAILABLE, you can execute the change set. If you can't\n execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE\n state because CloudFormation is still creating it or in an OBSOLETE state because the stack was\n already updated.
The current status of the change set, such as CREATE_IN_PROGRESS,\n CREATE_COMPLETE, or FAILED.
The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or\n FAILED.
A description of the change set's status. For example, if your attempt to create a change\n set failed, CloudFormation shows the error message.
" + "smithy.api#documentation": "A description of the change set's status. For example, if your attempt to create a change set failed, CloudFormation shows the error message.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated\n with the stack if you execute the change set.
" + "smithy.api#documentation": "The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you\n execute the change set.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating\n operations, and for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for\n the specified monitoring period afterwards.
" } }, "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged\n when the change set was created.
" + "smithy.api#documentation": "If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set\n was created.
" } }, "Tags": { @@ -3761,13 +3767,13 @@ "Changes": { "target": "com.amazonaws.cloudformation#Changes", "traits": { - "smithy.api#documentation": "A list of Change structures that describes the resources CloudFormation\n changes if you execute the change set.
A list of Change structures that describes the resources CloudFormation changes if you execute\n the change set.
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is\n no additional page, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,\n this value is null.
" } }, "IncludeNestedStacks": { @@ -3779,13 +3785,19 @@ "ParentChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "Specifies the change set ID of the parent change set in the current nested change set\n hierarchy.
" + "smithy.api#documentation": "Specifies the change set ID of the parent change set in the current nested change set hierarchy.
" } }, "RootChangeSetId": { "target": "com.amazonaws.cloudformation#ChangeSetId", "traits": { - "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set\n hierarchy.
" + "smithy.api#documentation": "Specifies the change set ID of the root change set in the current nested change set hierarchy.
" + } + }, + "OnStackFailure": { + "target": "com.amazonaws.cloudformation#OnStackFailure", + "traits": { + "smithy.api#documentation": "Determines what action will be taken if stack creation fails. When this parameter is specified, the\n DisableRollback parameter to the ExecuteChangeSet API operation must not\n be specified. This must be one of these values:
\n DELETE - Deletes the change set if the stack creation fails. This is only valid when the\n ChangeSetType parameter is set to CREATE. If the deletion of the stack fails, the status\n of the stack is DELETE_FAILED.
\n DO_NOTHING - if the stack creation fails, do nothing. This is equivalent to specifying\n true for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
\n ROLLBACK - if the stack creation fails, roll back the stack. This is equivalent to specifying\n false for the DisableRollback parameter to the ExecuteChangeSet API\n operation.
Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
Retrieves information about the account's OrganizationAccess status. This API\n can be called either by the management account or the delegated administrator by using the\n CallAs parameter. This API can also be called without the CallAs\n parameter by the management account.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing extensions\n to make them available for public use in the CloudFormation\n CLI User Guide\n
\nReturns information about a CloudFormation extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
For more information about registering as a publisher, see:
\n\n RegisterPublisher\n
\n\n Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide\n
\nThe ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension\n publisher, DescribePublisher returns information about your own publisher\n account.
The ID of the extension publisher.
\nIf you don't supply a PublisherId, and you have registered as an extension publisher,\n DescribePublisher returns information about your own publisher account.
Whether the publisher is verified. Currently, all registered publishers are\n verified.
" + "smithy.api#documentation": "Whether the publisher is verified. Currently, all registered publishers are verified.
" } }, "IdentityProvider": { "target": "com.amazonaws.cloudformation#IdentityProvider", "traits": { - "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with\n CloudFormation.
" + "smithy.api#documentation": "The type of account used as the identity provider when registering this publisher with CloudFormation.
" } }, "PublisherProfile": { @@ -3915,7 +3927,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackDriftDetectionStatusOutput" }, "traits": { - "smithy.api#documentation": "Returns information about a stack drift detection operation. A stack drift detection\n operation detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. A stack is considered to have\n drifted if one or more of its resources have drifted. For more information about stack and\n resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to\n monitor the progress of the operation using DescribeStackDriftDetectionStatus.\n Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
Returns information about a stack drift detection operation. A stack drift detection operation detects whether a\n stack's actual configuration differs, or has drifted, from its expected configuration, as\n defined in the stack template and any values specified as template parameters. A stack is considered to have drifted\n if one or more of its resources have drifted. For more information about stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to initiate a stack drift detection operation.\n DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of\n the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed,\n use DescribeStackResourceDrifts to return drift information about the stack and its\n resources.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of drift results CloudFormation retains for any given stack, and for how long,\n may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", "smithy.api#required": {} } } @@ -3946,20 +3958,20 @@ "StackDriftDetectionId": { "target": "com.amazonaws.cloudformation#StackDriftDetectionId", "traits": { - "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of reports CloudFormation retains for any given stack, and for how long, may\n vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of reports CloudFormation retains for any given stack, and for how long, may vary.
", "smithy.api#required": {} } }, "StackDriftStatus": { "target": "com.amazonaws.cloudformation#StackDriftStatus", "traits": { - "smithy.api#documentation": "Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A\n stack is considered to have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected\n template configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template\n configuration.
\n UNKNOWN: This value is reserved for future use.
Status of the stack's actual configuration compared to its expected configuration.
\n\n DRIFTED: The stack differs from its expected template configuration. A stack is considered to\n have drifted if one or more of its resources have drifted.
\n NOT_CHECKED: CloudFormation hasn't checked if the stack differs from its expected template\n configuration.
\n IN_SYNC: The stack's actual configuration matches its expected template configuration.
\n UNKNOWN: This value is reserved for future use.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully\n completed for all resources in the stack that support drift detection. (Resources that\n don't currently support stack detection remain unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift\n detection operation, only the resources with those logical IDs are checked for\n drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at\n least one resource in the stack. Results will be available for resources on which CloudFormation\n successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently\n in progress.
The status of the stack drift detection operation.
\n\n DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all\n resources in the stack that support drift detection. (Resources that don't currently support stack detection remain\n unchecked.)
If you specified logical resource IDs for CloudFormation to use as a filter for the stack drift detection operation,\n only the resources with those logical IDs are checked for drift.
\n\n DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the\n stack. Results will be available for resources on which CloudFormation successfully completed drift detection.
\n DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
Total number of stack resources that have drifted. This is NULL until the drift detection\n operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks\n whose drift status is IN_SYNC.
Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a\n status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is\n IN_SYNC.
Returns all stack related events for a specified stack in reverse chronological order. For\n more information about a stack's event history, go to Stacks in the\n CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by\n specifying the unique stack identifier (stack ID).
\nReturns all stack related events for a specified stack in reverse chronological order. For more information\n about a stack's event history, go to Stacks in the CloudFormation User Guide.
\nYou can list events for stacks that have failed to create or have been deleted by specifying the unique stack\n identifier (stack ID).
\nThe name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -4037,7 +4049,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events. If\n no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page\n exists, this value is null.
" } } }, @@ -4124,7 +4136,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceOutput" }, "traits": { - "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days\n after the stack has been deleted.
" + "smithy.api#documentation": "Returns a description of the specified resource in the specified stack.
\nFor deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has\n been deleted.
" } }, "com.amazonaws.cloudformation#DescribeStackResourceDrifts": { @@ -4136,7 +4148,7 @@ "target": "com.amazonaws.cloudformation#DescribeStackResourceDriftsOutput" }, "traits": { - "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the\n specified stack. This includes actual and expected configuration values for resources where\n CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that don't currently support drift detection aren't checked, and so\n not included. For a list of resources that support drift detection, see Resources\n that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all supported resources for a given\n stack.
", + "smithy.api#documentation": "Returns drift information for the resources that have been checked for drift in the specified stack. This\n includes actual and expected configuration values for resources where CloudFormation detects configuration drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -4157,7 +4169,7 @@ "StackResourceDriftStatusFilters": { "target": "com.amazonaws.cloudformation#StackResourceDriftStatusFilters", "traits": { - "smithy.api#documentation": "The resource drift status values to use as filters for the resource drift results\n returned.
\n\n DELETED: The resource differs from its expected template configuration in\n that the resource has been deleted.
\n MODIFIED: One or more resource properties differ from their expected\n template values.
\n IN_SYNC: The resource's actual configuration matches its expected\n template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The resource drift status values to use as filters for the resource drift results returned.
\n\n DELETED: The resource differs from its expected template configuration in that the resource has\n been deleted.
\n MODIFIED: One or more resource properties differ from their expected template values.
\n IN_SYNC: The resource's actual configuration matches its expected template configuration.
\n NOT_CHECKED: CloudFormation doesn't currently return this value.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
Drift information for the resources that have been checked for drift in the specified\n stack. This includes actual and expected configuration values for resources where CloudFormation\n detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack\n resource that has been checked for drift. Resources that haven't yet been checked for drift\n aren't included. Resources that do not currently support drift detection aren't checked, and\n so not included. For a list of resources that support drift detection, see Resources\n that Support Drift Detection.
Drift information for the resources that have been checked for drift in the specified stack. This includes\n actual and expected configuration values for resources where CloudFormation detects drift.
\nFor a given stack, there will be one StackResourceDrift for each stack resource that has been\n checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that do not currently\n support drift detection aren't checked, and so not included. For a list of resources that support drift detection,\n see Resources that Support Drift Detection.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call DescribeStackResourceDrifts\n again and assign that token to the request object's NextToken parameter. If the\n request returns all results, NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call DescribeStackResourceDrifts again and assign that token to the request\n object's NextToken parameter. If the request returns all results, NextToken is set to\n null.
The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, @@ -4227,7 +4239,7 @@ "StackResourceDetail": { "target": "com.amazonaws.cloudformation#StackResourceDetail", "traits": { - "smithy.api#documentation": "A StackResourceDetail structure containing the description of the specified\n resource in the specified stack.
A StackResourceDetail structure containing the description of the specified resource in the\n specified stack.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If\n StackName is specified, all the associated resources that are part of the stack\n are returned. If PhysicalResourceId is specified, the associated resources of the\n stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than\n this, you should use ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for\n up to 90 days after the stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not\n both. In addition, you can specify LogicalResourceId to filter the returned\n result. For more information about resources, the LogicalResourceId and\n PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName\n and PhysicalResourceId in the same request.
Returns Amazon Web Services resource descriptions for running and deleted stacks. If StackName is\n specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId\n is specified, the associated resources of the stack that the resource belongs to are returned.
Only the first 100 resources will be returned. If your stack has more resources than this, you should use\n ListStackResources instead.
For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the\n stack has been deleted.
You must specify either StackName or PhysicalResourceId, but not both. In addition,\n you can specify LogicalResourceId to filter the returned result. For more information about resources,\n the LogicalResourceId and PhysicalResourceId, go to the CloudFormation User Guide.
A ValidationError is returned if you specify both StackName and\n PhysicalResourceId in the same request.
The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
\nRequired: Conditional. If you don't specify StackName, you must specify\n PhysicalResourceId.
The name or unique identifier that corresponds to a physical instance ID of a resource\n supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance,\n PhysicalResourceId corresponds to the InstanceId. You can pass the\n EC2 InstanceId to DescribeStackResources to find which stack the\n instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must\n specify StackName.
Default: There is no default value.
" + "smithy.api#documentation": "The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.
\nFor example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to\n the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to\n find which stack the instance belongs to and what other resources are part of the stack.
Required: Conditional. If you don't specify PhysicalResourceId, you must specify\n StackName.
Default: There is no default value.
" } } }, @@ -4413,7 +4425,7 @@ "target": "com.amazonaws.cloudformation#DescribeStacksOutput" }, "traits": { - "smithy.api#documentation": "Returns the description for the specified stack; if no stack name was specified, then it\n returns the description for all the stacks created.
\nIf the stack doesn't exist, an ValidationError is returned.
Returns the description for the specified stack; if no stack name was specified, then it returns the description\n for all the stacks created.
\nIf the stack doesn't exist, an ValidationError is returned.
If you don't pass a parameter to StackName, the API returns a response\n that describes all resources in the account. This requires ListStacks and\n DescribeStacks permissions.
The IAM policy below can be added to IAM policies when you\n want to limit resource-level permissions and avoid returning a response when no parameter is\n sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\":\n \"cloudformation:DescribeStacks\", \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }]\n }
\nThe name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "If you don't pass a parameter to StackName, the API returns a response that describes all\n resources in the account. This requires ListStacks and DescribeStacks permissions.
The IAM policy below can be added to IAM policies when you want to limit\n resource-level permissions and avoid returning a response when no parameter is sent in the request:
\n{ \"Version\": \"2012-10-17\", \"Statement\": [{ \"Effect\": \"Deny\", \"Action\": \"cloudformation:DescribeStacks\",\n \"NotResource\": \"arn:aws:cloudformation:*:*:stack/*/*\" }] }
\nThe name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "NextToken": { @@ -4816,7 +4828,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" } } }, @@ -4842,7 +4854,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
Returns detailed information about an extension that has been registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information\n about that specific extension version. Otherwise, it returns information about the default\n extension version.
The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
\nIf you specify a VersionId, DescribeType returns information about that specific\n extension version. Otherwise, it returns information about the default extension version.
The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias,\n CloudFormation returns the type name alias. For more information, see ActivateType.
" + "smithy.api#documentation": "The name of the extension.
\nIf the extension is a public third-party type you have activated with a type name alias, CloudFormation\n returns the type name alias. For more information, see ActivateType.
" } }, "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the\n extension version isn't specified.
\nThis applies only to private extensions you have registered in your account. For public\n extensions, both those provided by Amazon Web Services and published by third parties, CloudFormation returns null. For more information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n .
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns null. For\n more information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "IsDefaultVersion": { "target": "com.amazonaws.cloudformation#IsDefaultVersion", "traits": { - "smithy.api#documentation": "Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and\n extensions published by Amazon Web Services. For public third-party extensions, whether they\n are activated in your account, CloudFormation returns null.
Whether the specified extension version is set as the default version.
\nThis applies only to private extensions you have registered in your account, and extensions published by Amazon Web Services. For public third-party extensions, whether they are activated in your account, CloudFormation\n returns null.
The contract test status of the registered extension version. To return the extension test\n status of a specific extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be\n published. For more information, see Publishing\n extensions to make them available for public use in the CloudFormation Command Line Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the\n extension.
\n NOT_TESTED: Contract tests haven't been performed on the\n extension.
The contract test status of the registered extension version. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
\n\n PASSED: The extension has passed all its contract tests.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation Command Line\n Interface User Guide.
\n FAILED: The extension has failed one or more contract tests.
\n IN_PROGRESS: Contract tests are currently being performed on the extension.
\n NOT_TESTED: Contract tests haven't been performed on the extension.
The description of the test status. To return the extension test status of a specific\n extension version, you must specify VersionId.
This applies only to registered private extension versions. CloudFormation\n doesn't return this information for public extensions, whether they are activated in your\n account.
" + "smithy.api#documentation": "The description of the test status. To return the extension test status of a specific extension version, you\n must specify VersionId.
This applies only to registered private extension versions. CloudFormation doesn't return this\n information for public extensions, whether they are activated in your account.
" } }, "Description": { @@ -4944,43 +4956,43 @@ "Schema": { "target": "com.amazonaws.cloudformation#TypeSchema", "traits": { - "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider\n Schema in the CloudFormation CLI User Guide.
" + "smithy.api#documentation": "The schema that defines the extension.
\nFor more information about extension schemas, see Resource Provider Schema in the\n CloudFormation CLI User Guide.
" } }, "ProvisioningType": { "target": "com.amazonaws.cloudformation#ProvisioningType", "traits": { - "smithy.api#documentation": "For resource type extensions, the provisioning behavior of the resource type. CloudFormation\n determines the provisioning type during registration, based on the types of handlers in the\n schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following\n handlers, and therefore can't actually be provisioned.
create
\nread
\ndelete
\nFor resource type extensions, the provisioning behavior of the resource type. CloudFormation determines the provisioning\n type during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include all the following handlers, and therefore\n can't actually be provisioned.
create
\nread
\ndelete
\nThe deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility\n scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no\n longer be used in CloudFormation operations.
For public third-party extensions, CloudFormation returns\n null.
The deprecation status of the extension version.
\nValid values include:
\n\n LIVE: The extension is activated or registered and can be used in CloudFormation\n operations, dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension has been deactivated or deregistered and can no longer be used in\n CloudFormation operations.
For public third-party extensions, CloudFormation returns null.
Contains logging configuration information for private extensions. This applies only to\n private extensions you have registered in your account. For public extensions, both those\n provided by Amazon Web Services and published by third parties, CloudFormation returns\n null. For more information, see RegisterType.
Contains logging configuration information for private extensions. This applies only to private extensions you\n have registered in your account. For public extensions, both those provided by Amazon Web Services and published by\n third parties, CloudFormation returns null. For more information, see RegisterType.
For extensions that are modules, the public third-party extensions that must be activated\n in your account in order for the module itself to be activated.
" + "smithy.api#documentation": "For extensions that are modules, the public third-party extensions that must be activated in your account in\n order for the module itself to be activated.
" } }, "ExecutionRoleArn": { "target": "com.amazonaws.cloudformation#RoleARN2", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register\n the extension. This applies only to private extensions you have registered in your account.\n For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an\n \n IAM execution role\n that includes the necessary permissions to\n call those Amazon Web Services APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the\n appropriate credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. This\n applies only to private extensions you have registered in your account. For more information, see RegisterType.
\nIf the registered extension calls any Amazon Web Services APIs, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. CloudFormation then assumes that execution role to provide your extension with the appropriate\n credentials.
" } }, "Visibility": { "target": "com.amazonaws.cloudformation#Visibility", "traits": { - "smithy.api#documentation": "The scope at which the extension is visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in\n which it is registered. CloudFormation marks any extensions you register as\n PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services account.
The scope at which the extension is visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: The extension is only visible and usable within the account in which it is registered.\n CloudFormation marks any extensions you register as PRIVATE.
\n PUBLIC: The extension is publicly visible and usable within any Amazon Web Services\n account.
When the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see\n RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For\n more information, see ActivateType.
\nWhen the specified extension version was registered. This applies only to:
\nPrivate extensions you have registered in your account. For more information, see RegisterType.
\nPublic extensions you have activated in your account with auto-update specified. For more information, see\n ActivateType.
\nWhen the specified private extension version was registered or activated in your\n account.
" + "smithy.api#documentation": "When the specified private extension version was registered or activated in your account.
" } }, "ConfigurationSchema": { "target": "com.amazonaws.cloudformation#ConfigurationSchema", "traits": { - "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this\n account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.
" + "smithy.api#documentation": "A JSON string that represent the current configuration data for the extension in this account and Region.
\nTo set the configuration data for an extension, use SetTypeConfiguration. For more\n information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
" } }, "PublisherId": { "target": "com.amazonaws.cloudformation#PublisherId", "traits": { - "smithy.api#documentation": "The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and\n extensions provided by Amazon Web Services, CloudFormation returns\n null.
The publisher ID of the extension publisher.
\nThis applies only to public third-party extensions. For private registered extensions, and extensions provided\n by Amazon Web Services, CloudFormation returns null.
For public extensions that have been activated for this account and Region, the type name\n of the public extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account\n and Region, CloudFormation treats that alias as the extension's type name within the\n account and Region, not the type name of the public extension. For more information, see\n Specifying aliases to refer to extensions in the\n CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the type name of the public\n extension.
\nIf you specified a TypeNameAlias when enabling the extension in this account and Region, CloudFormation treats that alias as the extension's type name within the account and Region, not the type name of\n the public extension. For more information, see Specifying aliases to\n refer to extensions in the CloudFormation User Guide.
For public extensions that have been activated for this account and Region, the Amazon\n Resource Name (ARN) of the public extension.
" + "smithy.api#documentation": "For public extensions that have been activated for this account and Region, the Amazon Resource Name (ARN) of\n the public extension.
" } }, "PublicVersionNumber": { "target": "com.amazonaws.cloudformation#PublicVersionNumber", "traits": { - "smithy.api#documentation": "The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or\n specify a public extension without specifying a version. For all other extensions, CloudFormation returns null.
The version number of a public third-party extension.
\nThis applies only if you specify a public extension you have activated in your account, or specify a public\n extension without specifying a version. For all other extensions, CloudFormation returns\n null.
The latest version of a public extension that is available for\n use.
\nThis only applies if you specify a public extension, and you don't specify a version. For\n all other requests, CloudFormation returns null.
The latest version of a public extension that is available for use.
\nThis only applies if you specify a public extension, and you don't specify a version. For all other requests,\n CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns null.
Whether the extension is activated in the account and Region.
\nThis only applies to public third-party extensions. For all other extensions, CloudFormation returns\n null.
Whether CloudFormation automatically updates the extension in this account and\n Region when a new minor version is published by the extension publisher.\n Major versions released by the publisher must be manually updated. For more information, see\n Activating public extensions for use in your account in the CloudFormation User Guide.
" + "smithy.api#documentation": "Whether CloudFormation automatically updates the extension in this account and Region when a new\n minor version is published by the extension publisher. Major versions released by the publisher\n must be manually updated. For more information, see Activating public extensions\n for use in your account in the CloudFormation User Guide.
" } } }, @@ -5074,7 +5086,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an extension's registration, including its current status and\n type and version identifiers.
\nWhen you initiate a registration request using \n RegisterType\n , you can then use \n DescribeTypeRegistration\n to monitor\n the progress of that registration request.
Once the registration request has completed, use \n DescribeType\n to return detailed information about an extension.
Returns information about an extension's registration, including its current status and type and version\n identifiers.
\nWhen you initiate a registration request using RegisterType, you can then use DescribeTypeRegistration to monitor the progress of that registration request.
\nOnce the registration request has completed, use DescribeType to return detailed information\n about an extension.
", "smithy.api#idempotent": {}, "smithy.waiters#waitable": { "TypeRegistrationComplete": { @@ -5112,7 +5124,7 @@ "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { - "smithy.api#documentation": "The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a\n registration request using \n RegisterType\n .
The identifier for this registration request.
\nThis registration token is generated by CloudFormation when you initiate a registration request using\n RegisterType.
", "smithy.api#required": {} } } @@ -5139,13 +5151,13 @@ "TypeArn": { "target": "com.amazonaws.cloudformation#TypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
The Amazon Resource Name (ARN) of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
The Amazon Resource Name (ARN) of this specific version of the extension being\n registered.
\nFor registration requests with a ProgressStatus of other than\n COMPLETE, this will be null.
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
\nFor registration requests with a ProgressStatus of other than COMPLETE, this will be\n null.
Detects whether a stack's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. For each resource in the stack that\n supports drift detection, CloudFormation compares the actual configuration of the resource with its\n expected template configuration. Only resource properties explicitly defined in the stack\n template are checked for drift. A stack is considered to have drifted if one or more of its\n resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given\n stack, or DetectStackResourceDrift to detect drift on individual\n resources.
For a list of stack resources that currently support drift detection, see Resources\n that Support Drift Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of\n resources contained within the stack. Use DescribeStackDriftDetectionStatus\n to monitor the progress of a detect stack drift operation. Once the drift detection operation\n has completed, use DescribeStackResourceDrifts to return drift information\n about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging\n to that stack. Perform DetectStackDrift directly on the nested stack\n itself.
Detects whether a stack's actual configuration differs, or has drifted, from its expected\n configuration, as defined in the stack template and any values specified as template parameters. For each resource in\n the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected\n template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A\n stack is considered to have drifted if one or more of its resources differ from their expected template\n configurations. For more information, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.
For a list of stack resources that currently support drift detection, see Resources that Support Drift\n Detection.
\n\n DetectStackDrift can take up to several minutes, depending on the number of resources contained\n within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack\n drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts\n to return drift information about the stack and its resources.
When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.\n Perform DetectStackDrift directly on the nested stack itself.
The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is\n run. However, the number of drift results CloudFormation retains for any given stack, and for how long,\n may vary.
", + "smithy.api#documentation": "The ID of the drift detection results of this operation.
\nCloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number\n of drift results CloudFormation retains for any given stack, and for how long, may vary.
", "smithy.api#required": {} } } @@ -5219,7 +5231,7 @@ "target": "com.amazonaws.cloudformation#DetectStackResourceDriftOutput" }, "traits": { - "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack\n template and any values specified as template parameters. This information includes actual and\n expected property values for resources in which CloudFormation detects drift. Only resource properties\n explicitly defined in the stack template are checked for drift. For more information about\n stack and resource drift, see Detecting Unregulated\n Configuration Changes to Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or\n DetectStackDrift to detect drift on all resources in a given stack that\n support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of\n resources that support drift detection, see Resources\n that Support Drift Detection.
" + "smithy.api#documentation": "Returns information about whether a resource's actual configuration differs, or has\n drifted, from its expected configuration, as defined in the stack template and any values\n specified as template parameters. This information includes actual and expected property values for resources in\n which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.\n For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to\n Stacks and Resources.
\nUse DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.
Resources that don't currently support drift detection can't be checked. For a list of resources that support\n drift detection, see Resources that Support Drift\n Detection.
" } }, "com.amazonaws.cloudformation#DetectStackResourceDriftInput": { @@ -5250,7 +5262,7 @@ "StackResourceDrift": { "target": "com.amazonaws.cloudformation#StackResourceDrift", "traits": { - "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its\n expected template configuration, including actual and expected property values and any\n differences detected.
", + "smithy.api#documentation": "Information about whether the resource's actual configuration has drifted from its expected template\n configuration, including actual and expected property values and any differences detected.
", "smithy.api#required": {} } } @@ -5279,7 +5291,7 @@ } ], "traits": { - "smithy.api#documentation": "Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with \n DescribeStackSetOperation\n to monitor the\n progress of the drift detection operation. The drift detection operation may take some time, depending on the number\n of stack instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse \n DescribeStackSet\n to return detailed information about the stack set,\n including detailed information about the last completed drift operation performed on the stack\n set. (Information about drift operations that are in progress isn't included.)
Use \n ListStackInstances\n to return a list of stack instances belonging to the\n stack set, including the drift status and last drift time checked of each instance.
Use \n DescribeStackInstance\n to return detailed information about a specific stack\n instance, including its drift status and last drift time checked.
For more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use \n StopStackSetOperation\n .
Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs\n drift detection on the stack associated with each stack instance in the stack set. For more information, see How CloudFormation\n performs drift detection on a stack set.
\n\n DetectStackSetDrift returns the OperationId of the stack set drift detection\n operation. Use this operation id with DescribeStackSetOperation to monitor the progress of the\n drift detection operation. The drift detection operation may take some time, depending on the number of stack\n instances included in the stack set, in addition to the number of resources included in each stack.
Once the operation has completed, use the following actions to return drift information:
\nUse DescribeStackSet to return detailed information about the stack set, including detailed\n information about the last completed drift operation performed on the stack set. (Information\n about drift operations that are in progress isn't included.)
\nUse ListStackInstances to return a list of stack instances belonging to the stack set,\n including the drift status and last drift time checked of each instance.
\nUse DescribeStackInstance to return detailed information about a specific stack instance,\n including its drift status and last drift time checked.
\nFor more information about performing a drift detection operation on a stack set, see Detecting unmanaged changes in\n stack sets.
\nYou can only run a single drift detection operation on a given stack set at one time.
\nTo stop a drift detection stack set operation, use StopStackSetOperation.
" } }, "com.amazonaws.cloudformation#DetectStackSetDriftInput": { @@ -5322,7 +5334,7 @@ "OperationId": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "The ID of the drift detection stack set operation.
\nYou can use this operation ID with \n DescribeStackSetOperation\n to monitor the\n progress of the drift detection operation.
The ID of the drift detection stack set operation.
\nYou can use this operation ID with DescribeStackSetOperation to monitor the progress of the\n drift detection operation.
" } } }, @@ -5395,7 +5407,7 @@ "target": "com.amazonaws.cloudformation#EstimateTemplateCostOutput" }, "traits": { - "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.
" + "smithy.api#documentation": "Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly\n Calculator URL with a query string that describes the resources required to run the template.
" } }, "com.amazonaws.cloudformation#EstimateTemplateCostInput": { @@ -5404,13 +5416,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. (For more information, go to Template Anatomy in\n the CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both\n are passed, only TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must pass TemplateBody or TemplateURL. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go\n to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the\n resources required to run the template.
" + "smithy.api#documentation": "An Amazon Web Services Simple Monthly Calculator URL with a query string that describes the resources required to\n run the template.
" } } }, @@ -5483,7 +5495,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a stack using the input information that was provided when the specified change\n set was created. After the call successfully completes, CloudFormation starts updating the\n stack. Use the DescribeStacks action to view the status of the\n update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated\n with the stack because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy\n during the update. You can't specify a temporary stack policy that overrides the current\n policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks\n must have been set to True.
Updates a stack using the input information that was provided when the specified change set was created. After\n the call successfully completes, CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
\nWhen you execute a change set, CloudFormation deletes all other change sets associated with the stack\n because they aren't valid for the updated stack.
\nIf a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You\n can't specify a temporary stack policy that overrides the current policy.
\nTo create a change set for the entire stack hierarchy, IncludeNestedStacks must have been set to\n True.
The name or Amazon Resource Name (ARN) of the change set that you want use to update the\n specified stack.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the change set that you want use to update the specified stack.
", "smithy.api#required": {} } }, "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name\n (ARN) that's associated with the change set you want to execute.
" + "smithy.api#documentation": "If you specified the name of a change set, specify the stack name or Amazon Resource Name (ARN) that's\n associated with the change set you want to execute.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this ExecuteChangeSet request. Specify this token if\n you plan to retry requests so that CloudFormation knows that you're not attempting to\n execute a change set to update a stack with the same name. You might retry\n ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry\n requests so that CloudFormation knows that you're not attempting to execute a change set to update a stack with\n the same name. You might retry ExecuteChangeSet requests to ensure that CloudFormation successfully\n received them.
Preserves the state of previously provisioned resources when an operation fails.
\nDefault: True\n
Preserves the state of previously provisioned resources when an operation\n fails. This parameter can't be specified when\n the OnStackFailure parameter to the CreateChangeSet API operation was\n specified.
\n True - if the stack creation fails, do nothing. This is equivalent to specifying\n DO_NOTHING for the OnStackFailure parameter to the CreateChangeSet API operation.
\n False - if the stack creation fails, roll back the stack. This is equivalent to specifying\n ROLLBACK for the OnStackFailure parameter to the CreateChangeSet API operation.
Default: True\n
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null\n value is returned.
" + "smithy.api#documentation": "Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is\n returned.
" } }, "com.amazonaws.cloudformation#GetStackPolicyInput": { @@ -5661,7 +5673,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to\n get.
", + "smithy.api#documentation": "The name or unique stack ID that's associated with the stack whose policy you want to get.
", "smithy.api#required": {} } } @@ -5677,7 +5689,7 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. (For more information, go to \n Prevent Updates to Stack Resources in the CloudFormation User Guide.)
" + "smithy.api#documentation": "Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in\n the CloudFormation User Guide.)
" } } }, @@ -5700,7 +5712,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the template body for a specified stack. You can get the template for running or\n deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after\n the stack has been deleted.
If the template doesn't exist, a ValidationError is returned.
Returns the template body for a specified stack. You can get the template for running or deleted stacks.
\nFor deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been\n deleted.
If the template doesn't exist, a ValidationError is returned.
The name or the unique stack ID that's associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" + "smithy.api#documentation": "The name or the unique stack ID that's associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
" } }, "ChangeSetName": { "target": "com.amazonaws.cloudformation#ChangeSetNameOrId", "traits": { - "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of a change set for which CloudFormation\n returns the associated template. If you specify a name, you must also specify the\n StackName.
The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated\n template. If you specify a name, you must also specify the StackName.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the user-submitted template, specify Original. To get the\n template after CloudFormation has processed all transforms, specify\n Processed.
If the template doesn't include transforms, Original and\n Processed return the same template. By default, CloudFormation\n specifies Processed.
For templates that include transforms, the stage of the template that CloudFormation returns. To get the\n user-submitted template, specify Original. To get the template after CloudFormation has\n processed all transforms, specify Processed.
If the template doesn't include transforms, Original and Processed return the same\n template. By default, CloudFormation specifies Processed.
Structure containing the template body. (For more information, go to Template\n Anatomy in the CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was\n created.
" + "smithy.api#documentation": "Structure containing the template body. (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nCloudFormation returns the same template that was used when the stack was created.
" } }, "StagesAvailable": { "target": "com.amazonaws.cloudformation#StageList", "traits": { - "smithy.api#documentation": "The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the\n Original template is always available. After CloudFormation finishes\n creating the change set, the Processed template becomes available.
The stage of the template that you can retrieve. For stacks, the Original and\n Processed templates are always available. For change sets, the Original template is always\n available. After CloudFormation finishes creating the change set, the Processed template becomes\n available.
Returns information about a new or existing template. The GetTemplateSummary\n action is useful for viewing parameter information, such as default parameter values and\n parameter types, before you create or update a stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you\n can get template information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for\n up to 90 days after the stack has been deleted. If the template doesn't exist, a\n ValidationError is returned.
Returns information about a new or existing template. The GetTemplateSummary action is useful for\n viewing parameter information, such as default parameter values and parameter types, before you create or update a\n stack or stack set.
You can use the GetTemplateSummary action when you submit a template, or you can get template\n information for a stack set, or a running or deleted stack.
For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the\n stack has been deleted. If the template doesn't exist, a ValidationError is returned.
Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information about templates, see Template anatomy in\n the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information about templates, see Template anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document.\n For more information about templates, see Template anatomy in\n the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see\n Template anatomy\n in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always\n interchangeable. For running stacks, you can specify either the stack's name or its unique\n stack ID. For deleted stack, you must specify the unique stack ID.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running\n stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the\n unique stack ID.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters:\n StackName, StackSetName, TemplateBody, or\n TemplateURL.
The name or unique ID of the stack set from which the stack was created.
\nConditional: You must specify only one of the following parameters: StackName,\n StackSetName, TemplateBody, or TemplateURL.
[Service-managed permissions] Specifies whether you are acting as an account administrator\n in the organization's management account or as a delegated administrator in a\n member account.
\nBy default, SELF is specified. Use SELF for stack sets with\n self-managed permissions.
If you are signed in to the management account, specify\n SELF.
If you are signed in to a delegated administrator account, specify\n DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the\n management account. For more information, see Register a\n delegated administrator in the CloudFormation User\n Guide.
\n[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's\n management account or as a delegated administrator in a member account.
\nBy default, SELF is specified. Use SELF for stack sets with self-managed\n permissions.
If you are signed in to the management account, specify SELF.
If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated\n administrator in the CloudFormation User Guide.
\nA list of parameter declarations that describe various properties for each\n parameter.
" + "smithy.api#documentation": "A list of parameter declarations that describe various properties for each parameter.
" } }, "Description": { @@ -5825,25 +5837,25 @@ "Capabilities": { "target": "com.amazonaws.cloudformation#Capabilities", "traits": { - "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM\n resources, you must specify the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template;\n otherwise, those actions return an InsufficientCapabilities error.
For more information, see Acknowledging\n IAM Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use\n the CreateStack or UpdateStack actions with your template; otherwise, those\n actions return an InsufficientCapabilities error.
For more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response\n element.
The list of resources that generated the values in the Capabilities response element.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and\n Custom::MyCustomInstance.
A list of all the template resource types that are defined in the template, such as\n AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
The Amazon Web Services template format version, which identifies the capabilities of the\n template.
" + "smithy.api#documentation": "The Amazon Web Services template format version, which identifies the capabilities of the template.
" } }, "Metadata": { @@ -5861,7 +5873,7 @@ "ResourceIdentifierSummaries": { "target": "com.amazonaws.cloudformation#ResourceIdentifierSummaries", "traits": { - "smithy.api#documentation": "A list of resource identifier summaries that describe the target resources of an import\n operation and the properties you can provide during the import to identify the target\n resources. For example, BucketName is a possible identifier property for an\n AWS::S3::Bucket resource.
A list of resource identifier summaries that describe the target resources of an import operation and the\n properties you can provide during the import to identify the target resources. For example, BucketName\n is a possible identifier property for an AWS::S3::Bucket resource.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or\n CREATE_PENDING state.
Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change\n sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change\n sets.
", + "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that\n identifies the next page of change sets that you want to retrieve.
" + "smithy.api#documentation": "A string (provided by the ListChangeSets response output) that identifies the next page of\n change sets that you want to retrieve.
" } } }, @@ -6425,13 +6437,13 @@ "Summaries": { "target": "com.amazonaws.cloudformation#ChangeSetSummaries", "traits": { - "smithy.api#documentation": "A list of ChangeSetSummary structures that provides the ID and status of each\n change set for the specified stack.
A list of ChangeSetSummary structures that provides the ID and status of each change set for the\n specified stack.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If\n there is no additional page, this value is null.
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional\n page, this value is null.
Lists all exported output values in the account and Region in which you call this action.\n Use this action to see the exported output values that you can import into other stacks. To\n import values, use the \n Fn::ImportValue\n function.
For more information, see \n CloudFormation export stack output values.
", + "smithy.api#documentation": "Lists all exported output values in the account and Region in which you call this action. Use this action to see\n the exported output values that you can import into other stacks. To import values, use the \n Fn::ImportValue function.
\nFor more information, see \n CloudFormation export stack output values.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6463,7 +6475,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies\n the next page of exported output values that you asked to retrieve.
" + "smithy.api#documentation": "A string (provided by the ListExports response output) that identifies the next page of\n exported output values that you asked to retrieve.
" } } }, @@ -6483,7 +6495,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page\n of exports. If there is no additional page, this value is null.
" + "smithy.api#documentation": "If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is\n no additional page, this value is null.
" } } }, @@ -6500,7 +6512,7 @@ "target": "com.amazonaws.cloudformation#ListImportsOutput" }, "traits": { - "smithy.api#documentation": "Lists all stacks that are importing an exported output value. To modify or remove an\n exported output value, first use this action to see which stacks are using it. To see the\n exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the \n Fn::ImportValue\n function.
Lists all stacks that are importing an exported output value. To modify or remove an exported output value,\n first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.
\nFor more information about importing an exported output value, see the Fn::ImportValue\n function.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6514,14 +6526,14 @@ "ExportName": { "target": "com.amazonaws.cloudformation#ExportName", "traits": { - "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are\n importing this value.
", + "smithy.api#documentation": "The name of the exported output value. CloudFormation returns the stack names that are importing this\n value.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies\n the next page of stacks that are importing the specified exported output value.
" + "smithy.api#documentation": "A string (provided by the ListImports response output) that identifies the next page of stacks\n that are importing the specified exported output value.
" } } }, @@ -6541,7 +6553,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this\n value is null.
" + "smithy.api#documentation": "A string that identifies the next page of exports. If there is no additional page, this value is null.
" } } }, @@ -6652,7 +6664,7 @@ "target": "com.amazonaws.cloudformation#ListStackResourcesOutput" }, "traits": { - "smithy.api#documentation": "Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days\n after the stack has been deleted.
", + "smithy.api#documentation": "Returns descriptions of all resources of the specified stack.
\nFor deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been\n deleted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6666,14 +6678,14 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackName", "traits": { - "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always\n interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", + "smithy.api#documentation": "The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:
\nRunning stacks: You can specify either the stack's name or its unique stack ID.
\nDeleted stacks: You must specify the unique stack ID.
\nDefault: There is no default value.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to\n retrieve.
" + "smithy.api#documentation": "A string that identifies the next page of stack resources that you want to retrieve.
" } } }, @@ -6694,7 +6706,7 @@ "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack resources. If\n no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page\n exists, this value is null.
" } } }, @@ -6950,7 +6962,7 @@ "target": "com.amazonaws.cloudformation#ListStacksOutput" }, "traits": { - "smithy.api#documentation": "Returns the summary information for stacks whose status matches the specified\n StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days\n after the stack is deleted. If no StackStatusFilter is specified, summary information for all\n stacks is returned (including existing stacks and stacks that have been deleted).
", + "smithy.api#documentation": "Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary\n information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter\n is specified, summary information for all stacks is returned (including existing stacks and stacks that have been\n deleted).
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -6970,7 +6982,7 @@ "StackStatusFilter": { "target": "com.amazonaws.cloudformation#StackStatusFilter", "traits": { - "smithy.api#documentation": "Stack status to use as a filter. Specify one or more stack status codes to list only\n stacks with the specified status codes. For a complete list of stack status codes, see the\n StackStatus parameter of the Stack data type.
Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified\n status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.
A list of StackSummary structures containing information about the specified\n stacks.
A list of StackSummary structures containing information about the specified stacks.
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If\n no additional page exists, this value is null.
" + "smithy.api#documentation": "If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page\n exists, this value is null.
" } } }, @@ -7029,19 +7041,19 @@ "Type": { "target": "com.amazonaws.cloudformation#RegistryType", "traits": { - "smithy.api#documentation": "The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of extension registration tokens.
\nUse \n DescribeTypeRegistration\n to return detailed information\n about a type registration request.
A list of extension registration tokens.
\nUse DescribeTypeRegistration to return detailed information about a type registration\n request.
" } }, "NextToken": { "target": "com.amazonaws.cloudformation#NextToken", "traits": { - "smithy.api#documentation": "If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
The kind of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all of the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.
If the previous paginated request didn't return all of the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
The deprecation status of the extension versions that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility\n scope.
\n DEPRECATED: The extension version has been deregistered and can no longer\n be used in CloudFormation operations.
The default is LIVE.
The deprecation status of the extension versions that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension version is registered and can be used in CloudFormation operations,\n dependent on its provisioning behavior and visibility scope.
\n DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.
The default is LIVE.
A list of TypeVersionSummary structures that contain information about the\n specified extension's versions.
A list of TypeVersionSummary structures that contain information about the specified extension's\n versions.
If the request doesn't return all of the remaining results, NextToken is set\n to a token. To retrieve the next set of results, call this action again and assign that token\n to the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
If the request doesn't return all of the remaining results, NextToken is set to a token. To\n retrieve the next set of results, call this action again and assign that token to the request object's\n NextToken parameter. If the request returns all results, NextToken is set to\n null.
The scope at which the extensions are visible and usable in CloudFormation\n operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and\n Region. This includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be\n activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party publishers.
The default is PRIVATE.
The scope at which the extensions are visible and usable in CloudFormation operations.
\nValid values include:
\n\n PRIVATE: Extensions that are visible and usable within this account and Region. This\n includes:
Private extensions you have registered in this account and Region.
\nPublic extensions that you have activated in this account and Region.
\n\n PUBLIC: Extensions that are publicly visible and available to be activated within any Amazon Web Services account. This includes extensions from Amazon Web Services, in addition to third-party\n publishers.
The default is PRIVATE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines the\n provisioning type during registration, based on the types of handlers in the schema handler\n package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process\n updates to the type during stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the\n type can't be updated and must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and\n delete handlers, and therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
For resource types, the provisioning behavior of the resource type. CloudFormation determines the provisioning type\n during registration, based on the types of handlers in the schema handler package submitted.
\nValid values include:
\n\n FULLY_MUTABLE: The resource type includes an update handler to process updates to the type during\n stack update operations.
\n IMMUTABLE: The resource type doesn't include an update handler, so the type can't be updated and\n must instead be replaced during stack update operations.
\n NON_PROVISIONABLE: The resource type doesn't include create, read, and delete handlers, and\n therefore can't actually be provisioned.
The default is FULLY_MUTABLE.
The deprecation status of the extension that you want to get summary information\n about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation\n operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used\n in CloudFormation operations.
The deprecation status of the extension that you want to get summary information about.
\nValid values include:
\n\n LIVE: The extension is registered for use in CloudFormation operations.
\n DEPRECATED: The extension has been deregistered and can no longer be used in CloudFormation operations.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For\n example, specifying AWS_TYPES for Category and PRIVATE\n for Visibility returns an empty list of types, but specifying PUBLIC\n for Visibility returns the desired list.
Filter criteria to use in determining which extensions to return.
\nFilters must be compatible with Visibility to return valid results. For example, specifying\n AWS_TYPES for Category and PRIVATE for Visibility returns an\n empty list of types, but specifying PUBLIC for Visibility returns the desired list.
The maximum number of results to be returned with a single call. If the number of\n available results exceeds this maximum, the response includes a NextToken value\n that you can assign to the NextToken request parameter to get the next set of\n results.
The maximum number of results to be returned with a single call. If the number of available results exceeds this\n maximum, the response includes a NextToken value that you can assign to the NextToken\n request parameter to get the next set of results.
If the previous paginated request didn't return all the remaining results, the response\n object's NextToken parameter value is set to a token. To retrieve the next set of\n results, call this action again and assign that token to the request object's\n NextToken parameter. If there are no remaining results, the previous response\n object's NextToken parameter is set to null.
If the previous paginated request didn't return all the remaining results, the response object's\n NextToken parameter value is set to a token. To retrieve the next set of results, call this action\n again and assign that token to the request object's NextToken parameter. If there are no remaining\n results, the previous response object's NextToken parameter is set to null.
A list of TypeSummary structures that contain information about the specified\n extensions.
A list of TypeSummary structures that contain information about the specified extensions.
If the request doesn't return all the remaining results, NextToken is set to\n a token. To retrieve the next set of results, call this action again and assign that token to\n the request object's NextToken parameter. If the request returns all results,\n NextToken is set to null.
If the request doesn't return all the remaining results, NextToken is set to a token. To retrieve\n the next set of results, call this action again and assign that token to the request object's NextToken\n parameter. If the request returns all results, NextToken is set to null.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n \n SSM\n parameter types in the template.
Read-only. The value that corresponds to a SSM parameter key. This field is returned only for\n SSM\n parameter types in the template.
" } } }, @@ -7991,7 +8026,7 @@ } ], "traits": { - "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public\n extension in this Region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to\n make them available for public use in the CloudFormation CLI User\n Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.
", + "smithy.api#documentation": "Publishes the specified extension to the CloudFormation registry as a public extension in this Region.\n Public extensions are available for use by all CloudFormation users. For more information about publishing\n extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI\n User Guide.
\nTo publish an extension, you must be registered as a publisher with CloudFormation. For more\n information, see RegisterPublisher.
", "smithy.api#idempotent": {} } }, @@ -8001,25 +8036,25 @@ "Type": { "target": "com.amazonaws.cloudformation#ThirdPartyType", "traits": { - "smithy.api#documentation": "The type of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The type of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version\n number to your extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning\n 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version\n number by one minor version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation\n automatically sets the first version number to be 1.0.0.
The version number to assign to this version of the extension.
\nUse the following format, and adhere to semantic versioning when assigning a version number to your\n extension:
\n\n MAJOR.MINOR.PATCH\n
For more information, see Semantic Versioning 2.0.0.
\nIf you don't specify a version number, CloudFormation increments the version number by one minor\n version release.
\nYou cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first\n version number to be 1.0.0.
Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't use this API in your code.
", + "smithy.api#documentation": "Reports progress of a resource handler to CloudFormation.
\nReserved for use by the CloudFormation CLI. Don't\n use this API in your code.
", "smithy.api#idempotent": {} } }, @@ -8118,45 +8153,45 @@ "BearerToken": { "target": "com.amazonaws.cloudformation#ClientToken", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, "OperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
", + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
", "smithy.api#required": {} } }, "CurrentOperationStatus": { "target": "com.amazonaws.cloudformation#OperationStatus", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "StatusMessage": { "target": "com.amazonaws.cloudformation#StatusMessage", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ErrorCode": { "target": "com.amazonaws.cloudformation#HandlerErrorCode", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ResourceModel": { "target": "com.amazonaws.cloudformation#ResourceModel", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "Reserved for use by the CloudFormation CLI.
" + "smithy.api#documentation": "Reserved for use by the CloudFormation\n CLI.
" } } }, @@ -8214,7 +8249,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation\n registry. Public extensions are available for use by all CloudFormation users. This\n publisher ID applies to your account in all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see\n Registering your account to publish CloudFormation extensions in the\n CloudFormation CLI User Guide.
\n ", + "smithy.api#documentation": "Registers your account as a publisher of public extensions in the CloudFormation registry. Public\n extensions are available for use by all CloudFormation users. This publisher ID applies to your account in\n all Amazon Web Services Regions.
\nFor information about requirements for registering as a public extension publisher, see Registering your account to publish CloudFormation extensions in the CloudFormation CLI User Guide.
\n ", "smithy.api#idempotent": {} } }, @@ -8224,13 +8259,13 @@ "AcceptTermsAndConditions": { "target": "com.amazonaws.cloudformation#AcceptTermsAndConditions", "traits": { - "smithy.api#documentation": "Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation\n registry. You must accept the terms and conditions in order to register to publish public\n extensions to the CloudFormation registry.
\nThe default is false.
Whether you accept the Terms and Conditions for publishing extensions in the CloudFormation registry. You must accept the\n terms and conditions in order to register to publish public extensions to the CloudFormation\n registry.
\nThe default is false.
If you are using a Bitbucket or GitHub account for identity verification, the Amazon\n Resource Name (ARN) for your connection to that account.
\nFor more information, see Registering your account to publish CloudFormation extensions in the\n CloudFormation CLI User Guide.
" + "smithy.api#documentation": "If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for\n your connection to that account.
\nFor more information, see Registering your account\n to publish CloudFormation extensions in the CloudFormation CLI User\n Guide.
" } } }, @@ -8266,7 +8301,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension\n makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see\n Creating Resource Providers in the CloudFormation CLI User\n Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This\n maximum is per account and per Region. Use DeregisterType\n to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using \n RegisterType\n , you can use \n DescribeTypeRegistration\n to monitor\n the progress of the registration request.
Once you have registered a private extension in your account and Region, use SetTypeConfiguration to specify configuration properties for the extension. For\n more information, see Configuring extensions at the account level in the CloudFormation User Guide.
", + "smithy.api#documentation": "Registers an extension with the CloudFormation service. Registering an extension makes it available for\n use in CloudFormation templates in your Amazon Web Services account, and includes:
\nValidating the extension schema.
\nDetermining which handlers, if any, have been specified for the extension.
\nMaking the extension available for use in your account.
\nFor more information about how to develop extensions and ready them for registration, see Creating Resource\n Providers in the CloudFormation CLI User Guide.
\nYou can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and\n per Region. Use DeregisterType to deregister specific extension versions if necessary.
\nOnce you have initiated a registration request using RegisterType, you can use DescribeTypeRegistration to monitor the progress of the registration request.
\nOnce you have registered a private extension in your account and Region, use SetTypeConfiguration to specify\n configuration properties for the extension. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
", "smithy.api#idempotent": {} } }, @@ -8282,14 +8317,14 @@ "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension\n names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
The name of the extension being registered.
\nWe suggest that extension names adhere to the following patterns:
\nFor resource types,\n company_or_organization::service::type.
\nFor modules,\n company_or_organization::service::type::MODULE.
\nFor hooks,\n MyCompany::Testing::MyTestHook.
\nThe following organization namespaces are reserved and can't be used in your extension names:
\n\n Alexa\n
\n AMZN\n
\n Amazon\n
\n AWS\n
\n Custom\n
\n Dev\n
A URL to the S3 bucket containing the extension project package that contains the\n necessary files for the extension you want to register.
\nFor information about generating a schema handler package for the extension you want to\n register, see submit in\n the CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket.\n That's, the user needs to have GetObject permissions for the schema\n handler package. For more information, see Actions, Resources, and Condition Keys for\n Amazon S3 in the Identity and Access Management User\n Guide.
\nA URL to the S3 bucket containing the extension project package that contains the necessary files for the\n extension you want to register.
\nFor information about generating a schema handler package for the extension you want to register, see submit in the\n CloudFormation CLI User Guide.
\nThe user registering the extension must be able to access the package in the S3 bucket. That's, the user needs\n to have GetObject permissions for\n the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3\n in the Identity and Access Management User Guide.
\nThe Amazon Resource Name (ARN) of the IAM role for CloudFormation\n to assume when invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain\n a trust relationship with the CloudFormation service principle\n (resources.cloudformation.amazonaws.com). For more information about adding\n trust relationships, see Modifying a role trust policy in the Identity and Access Management User\n Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an\n \n IAM execution role\n that includes the necessary permissions to\n call those Amazon Web Services APIs, and provision that execution role in your account. When\n CloudFormation needs to invoke the resource type handler, CloudFormation\n assumes this execution role to create a temporary session token, which it then passes to the\n resource type handler, thereby supplying your resource type with the appropriate\n credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when\n invoking the extension.
\nFor CloudFormation to assume the specified execution role, the role must contain a trust relationship\n with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more\n information about adding trust relationships, see Modifying a\n role trust policy in the Identity and Access Management User Guide.
If your extension calls Amazon Web Services APIs in any of its handlers, you must create an \n IAM execution role\n \n that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in\n your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this\n execution role to create a temporary session token, which it then passes to the resource type handler, thereby\n supplying your resource type with the appropriate credentials.
" } }, "ClientRequestToken": { "target": "com.amazonaws.cloudformation#RequestToken", "traits": { - "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request.\n Specifying a client request token prevents CloudFormation from generating more than\n one version of an extension from the same registration request, even if the request is\n submitted multiple times.
" + "smithy.api#documentation": "A unique identifier that acts as an idempotency key for this registration request. Specifying a client request\n token prevents CloudFormation from generating more than one version of an extension from the same\n registration request, even if the request is submitted multiple times.
" } } }, @@ -8322,7 +8357,7 @@ "RegistrationToken": { "target": "com.amazonaws.cloudformation#RegistrationToken", "traits": { - "smithy.api#documentation": "The identifier for this registration request.
\nUse this registration token when calling \n DescribeTypeRegistration\n , which returns information about the status and IDs of the extension\n registration.
The identifier for this registration request.
\nUse this registration token when calling DescribeTypeRegistration, which returns information\n about the status and IDs of the extension registration.
" } } }, @@ -8672,24 +8707,24 @@ "ResourceType": { "target": "com.amazonaws.cloudformation#ResourceType", "traits": { - "smithy.api#documentation": "The template resource type of the target resources, such as\n AWS::S3::Bucket.
The template resource type of the target resources, such as AWS::S3::Bucket.
The logical IDs of the target resources of the specified ResourceType, as\n defined in the import template.
The logical IDs of the target resources of the specified ResourceType, as defined in the import\n template.
The resource properties you can provide during the import to identify your target\n resources. For example, BucketName is a possible identifier property for\n AWS::S3::Bucket resources.
The resource properties you can provide during the import to identify your target resources. For example,\n BucketName is a possible identifier property for AWS::S3::Bucket resources.
Describes the target resources of a specific type in your import template (for example,\n all AWS::S3::Bucket resources) and the properties you can provide during the\n import to identify resources of that type.
Describes the target resources of a specific type in your import template (for example, all\n AWS::S3::Bucket resources) and the properties you can provide during the import to identify resources\n of that type.
When specifying RollbackStack, you preserve the state of previously\n provisioned resources when an operation fails. You can check the status of the stack through\n the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from\n CREATE_FAILED or UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last\n known stable state includes any status in a *_COMPLETE. This includes the\n following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
When specifying RollbackStack, you preserve the state of previously provisioned resources when an\n operation fails. You can check the status of the stack through the DescribeStacks operation.
Rolls back the specified stack to the last known stable state from CREATE_FAILED or\n UPDATE_FAILED stack statuses.
This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state\n includes any status in a *_COMPLETE. This includes the following stack statuses.
\n CREATE_COMPLETE\n
\n UPDATE_COMPLETE\n
\n UPDATE_ROLLBACK_COMPLETE\n
\n IMPORT_COMPLETE\n
\n IMPORT_ROLLBACK_COMPLETE\n
The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation\n assumes to rollback the stack.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management role that CloudFormation assumes to rollback the\n stack.
" } }, "ClientRequestToken": { @@ -9169,13 +9204,13 @@ "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing the stack policy body. For more information, go to \n Prevent updates to stack resources in the CloudFormation User Guide. You can specify either\n the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
Structure containing the stack policy body. For more information, go to Prevent updates to stack resources in\n the CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL\n parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum\n size: 16 KB) located in an Amazon S3 bucket in the same Amazon Web Services Region as\n the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in\n an Amazon S3 bucket in the same Amazon Web Services Region as the stack. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not both.
Specifies the configuration data for a registered CloudFormation extension, in\n the given account and Region.
\nTo view the current configuration data for an extension, refer to the\n ConfigurationSchema element of DescribeType. For\n more information, see Configuring extensions at the account level in the\n CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive\n configuration definitions, such as third-party credentials. For more details on dynamic\n references, see Using dynamic references to specify\n template values in the CloudFormation User Guide.
\nSpecifies the configuration data for a registered CloudFormation extension, in the given account and\n Region.
\nTo view the current configuration data for an extension, refer to the ConfigurationSchema element\n of DescribeType. For more information, see Configuring extensions at\n the account level in the CloudFormation User Guide.
It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such\n as third-party credentials. For more details on dynamic references, see Using\n dynamic references to specify template values in the CloudFormation User\n Guide.
\nThe Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type\n in this account and Region. For private extensions, this will be the ARN assigned when you\n register the type\n in this account and Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the\n configuration for an extension, but not for a specific extension version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the extension, in this account and Region.
\nFor public extensions, this will be the ARN assigned when you activate the type in this account and\n Region. For private extensions, this will be the ARN assigned when you register the type in this account and\n Region.
\nDo not include the extension versions suffix at the end of the ARN. You can set the configuration for an\n extension, but not for a specific extension version.
" } }, "Configuration": { "target": "com.amazonaws.cloudformation#TypeConfiguration", "traits": { - "smithy.api#documentation": "The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned\n in the ConfigurationSchema response element of DescribeType. For\n more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.
The configuration data for the extension, in this account and Region.
\nThe configuration data must be formatted as JSON, and validate against the schema returned in the\n ConfigurationSchema response element of DescribeType. For more information, see\n Defining\n account-level configuration data for an extension in the CloudFormation CLI User\n Guide.
An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for\n a resource type extension.
" + "smithy.api#documentation": "An alias by which to refer to this extension configuration data.
\nConditional: Specifying a configuration alias is required when setting a configuration for a resource type\n extension.
" } }, "TypeName": { "target": "com.amazonaws.cloudformation#TypeName", "traits": { - "smithy.api#documentation": "The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The name of the extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The type of extension.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and\n Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
The Amazon Resource Name (ARN) for the configuration data, in this account and Region.
\nConditional: You must specify ConfigurationArn, or Type and\n TypeName.
Specify the default version of an extension. The default version of an extension will be\n used in CloudFormation operations.
", + "smithy.api#documentation": "Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.
", "smithy.api#idempotent": {} } }, @@ -9284,25 +9319,25 @@ "Arn": { "target": "com.amazonaws.cloudformation#PrivateTypeArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the extension for which you want version summary\n information.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The Amazon Resource Name (ARN) of the extension for which you want version summary information.
\nConditional: You must specify either TypeName and Type, or Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The kind of extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or\n Arn.
The name of the extension.
\nConditional: You must specify either TypeName and Type, or Arn.
The ID of a specific version of the extension. The version ID is the value at the end of\n the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
" + "smithy.api#documentation": "The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource\n Name (ARN) assigned to the extension version when it is registered.
" } } }, @@ -9326,7 +9361,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update\n policy. CloudFormation doesn't proceed with a stack creation or update until resources\n receive the required number of signals or the timeout period is exceeded. The\n SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
Sends a signal to the specified resource with a success or failure status. You can use the\n SignalResource operation in conjunction with a creation policy or update policy. CloudFormation\n doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout\n period is exceeded. The SignalResource operation is useful in cases where you want to send signals from\n anywhere other than an Amazon EC2 instance.
The stack name or unique stack ID that includes the resource that you want to\n signal.
", + "smithy.api#documentation": "The stack name or unique stack ID that includes the resource that you want to signal.
", "smithy.api#required": {} } }, "LogicalResourceId": { "target": "com.amazonaws.cloudformation#LogicalResourceId", "traits": { - "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the\n resource that given in the template.
", + "smithy.api#documentation": "The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in\n the template.
", "smithy.api#required": {} } }, "UniqueId": { "target": "com.amazonaws.cloudformation#ResourceSignalUniqueId", "traits": { - "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send\n multiple signals to a single resource (such as signaling a wait condition), each signal\n requires a different unique ID.
", + "smithy.api#documentation": "A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the\n instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as\n signaling a wait condition), each signal requires a different unique ID.
", "smithy.api#required": {} } }, "Status": { "target": "com.amazonaws.cloudformation#ResourceSignalStatus", "traits": { - "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes\n CloudFormation to immediately fail the stack creation or update.
", + "smithy.api#documentation": "The status of the signal, which is either success or failure. A failure signal causes CloudFormation to\n immediately fail the stack creation or update.
", "smithy.api#required": {} } } @@ -9834,7 +9869,7 @@ "DetailedStatus": { "target": "com.amazonaws.cloudformation#StackInstanceDetailedStatus", "traits": { - "smithy.api#documentation": "\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
\n CANCELLED: The operation in the specified account and Region has been canceled. This is either\n because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has\n been exceeded.
\n FAILED: The operation in the specified account and Region failed. If the stack set operation\n fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be\n exceeded.
\n INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an\n unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might\n need to perform a DeleteStackInstances operation, with RetainStacks set to\n true, to delete the stack instance, and then delete the stack manually.
\n PENDING: The operation in the specified account and Region has yet to start.
\n RUNNING: The operation in the specified account and Region is currently in progress.
\n SKIPPED_SUSPENDED_ACCOUNT: The operation in the specified account and Region has been skipped\n because the account was suspended at the time of the operation.
\n SUCCEEDED: The operation in the specified account and Region completed successfully.
The order of the Regions in where you want to perform the stack operation.
" + "smithy.api#documentation": "The order of the Regions where you want to perform the stack operation.
" } }, "FailureToleranceCount": { @@ -11753,7 +11794,7 @@ } ], "traits": { - "smithy.api#documentation": "Tests a registered extension to make sure it meets all necessary requirements for being\n published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the\n type.
\nFor modules, this includes determining if the module's model meets all necessary\n requirements.
\nFor more information, see Testing your public extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the\n extension in your account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the\n type was registered. For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass\n the returned TypeVersionArn into DescribeType to\n monitor the current test status and test status description for the extension.
An extension must have a test status of PASSED before it can be published.\n For more information, see Publishing extensions\n to make them available for public use in the CloudFormation CLI\n User Guide.
Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.
\nFor resource types, this includes passing all contracts tests defined for the type.
\nFor modules, this includes determining if the module's model meets all necessary requirements.
\nFor more information, see Testing your public\n extension prior to publishing in the CloudFormation CLI User Guide.
\nIf you don't specify a version, CloudFormation uses the default version of the extension in your\n account and Region for testing.
\nTo perform testing, CloudFormation assumes the execution role specified when the type was registered.\n For more information, see RegisterType.
\nOnce you've initiated testing on an extension using TestType, you can pass the returned\n TypeVersionArn into DescribeType to monitor the current test\n status and test status description for the extension.
An extension must have a test status of PASSED before it can be published. For more information,\n see Publishing\n extensions to make them available for public use in the CloudFormation CLI User\n Guide.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and\n Type.
The Amazon Resource Name (ARN) of the extension.
\nConditional: You must specify Arn, or TypeName and Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The type of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and\n Type.
The name of the extension to test.
\nConditional: You must specify Arn, or TypeName and Type.
The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName\n and Type.
If you don't specify a version, CloudFormation uses the default version of the\n extension in this account and Region for testing.
" + "smithy.api#documentation": "The version of the extension to test.
\nYou can specify the version id with either Arn, or with TypeName and\n Type.
If you don't specify a version, CloudFormation uses the default version of the extension in this\n account and Region for testing.
" } }, "LogDeliveryBucket": { "target": "com.amazonaws.cloudformation#S3Bucket", "traits": { - "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution\n logs.
\nCloudFormation delivers the logs by the time contract testing has completed and\n the extension has been assigned a test type status of PASSED or\n FAILED.
The user calling TestType must be able to access items in the specified S3\n bucket. Specifically, the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and\n Condition Keys for Amazon S3 in the Amazon Web Services Identity\n and Access Management User Guide.
" + "smithy.api#documentation": "The S3 bucket to which CloudFormation delivers the contract test execution logs.
\nCloudFormation delivers the logs by the time contract testing has completed and the extension has been\n assigned a test type status of PASSED or FAILED.
The user calling TestType must be able to access items in the specified S3 bucket. Specifically,\n the user needs the following permissions:
\n GetObject\n
\n PutObject\n
For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.
" } } }, @@ -12152,7 +12193,7 @@ "DefaultVersionId": { "target": "com.amazonaws.cloudformation#TypeVersionId", "traits": { - "smithy.api#documentation": "The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use \n SetTypeDefaultVersion\n .
The ID of the default version of the extension. The default version is used when the extension version isn't\n specified.
\nThis applies only to private extensions you have registered in your account. For public extensions, both those\n provided by Amazon and published by third parties, CloudFormation returns null. For more\n information, see RegisterType.
To set the default version of an extension, use SetTypeDefaultVersion.
" } }, "TypeArn": { @@ -12354,7 +12395,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the\n stack update starts. You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate action.
\nFor more information about creating an update template, updating a stack, and monitoring\n the progress of the update, see Updating a\n Stack.
" + "smithy.api#documentation": "Updates a stack as specified in the template. After the call completes successfully, the stack update starts.\n You can check the status of the stack through the DescribeStacks action.
\nTo get a copy of the template for an existing stack, you can use the GetTemplate\n action.
\nFor more information about creating an update template, updating a stack, and monitoring the progress of the\n update, see Updating a Stack.
" } }, "com.amazonaws.cloudformation#UpdateStackInput": { @@ -12370,85 +12411,85 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. (For more information, go to Template Anatomy in\n the CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.\n (For more information, go to Template Anatomy in the\n CloudFormation User Guide.)
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's\n located in an Amazon S3 bucket or a Systems Manager document. For more information, go\n to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are\n updating.
\nConditional: You must specify only one of the following parameters:\n TemplateBody, TemplateURL, or set the\n UsePreviousTemplate to true.
Reuse the existing template that is associated with the stack that you are updating.
\nConditional: You must specify only one of the following parameters: TemplateBody,\n TemplateURL, or set the UsePreviousTemplate to true.
Structure containing the temporary overriding stack policy body. You can specify either\n the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL\n parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.
" + "smithy.api#documentation": "Structure containing the temporary overriding stack policy body. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "StackPolicyDuringUpdateURL": { "target": "com.amazonaws.cloudformation#StackPolicyDuringUpdateURL", "traits": { - "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to\n a policy (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can\n specify either the StackPolicyDuringUpdateBody or the\n StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy\n during this update. If you don't specify a stack policy, the current policy that is associated\n with the stack will be used.
" + "smithy.api#documentation": "Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:\n 16KB) located in an S3 bucket in the same Region as the stack. You can specify either the\n StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not\n both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If\n you don't specify a stack policy, the current policy that is associated with the stack will be used.
" } }, "Parameters": { "target": "com.amazonaws.cloudformation#Parameters", "traits": { - "smithy.api#documentation": "A list of Parameter structures that specify input parameters for the stack.\n For more information, see the Parameter data\n type.
A list of Parameter structures that specify input parameters for the stack. For more information,\n see the Parameter\n data type.
In some cases, you must explicitly acknowledge that your stack template contains certain\n capabilities in order for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your\n Amazon Web Services account; for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying\n one of these capabilities.
\nThe following IAM resources require you to specify either the\n CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either\n capability.
\nIf you have IAM resources with custom names, you\n must specify CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all\n permissions associated with them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can\n include simple actions like find-and-replace operations, all the way to extensive\n transformations of entire templates. Because of this, users typically create a change set\n from the processed template, so that they can review the changes resulting from the macros\n before actually updating the stack. If your stack template contains one or more macros,\n and you choose to update a stack directly from the processed template, without first\n reviewing the resulting changes in a change set, you must acknowledge this capability.\n This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros\n and nested stacks, you must update the stack directly from the\n template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if\n you know what processing the macro performs.
\nEach macro relies on an underlying Lambda service function for\n processing stack templates. Be aware that the Lambda function owner can\n update the function operation without CloudFormation being notified.
\nFor more information, see Using\n CloudFormation Macros to Perform Custom Processing on\n Templates.
\nIn some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order\n for CloudFormation to update the stack.
\n\n CAPABILITY_IAM and CAPABILITY_NAMED_IAM\n
Some stack templates might include resources that can affect permissions in your Amazon Web Services account;\n for example, by creating new Identity and Access Management (IAM) users. For those stacks, you must\n explicitly acknowledge this by specifying one of these capabilities.
\nThe following IAM resources require you to specify either the CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM capability.
If you have IAM resources, you can specify either capability.
\nIf you have IAM resources with custom names, you must specify\n CAPABILITY_NAMED_IAM.
If you don't specify either of these capabilities, CloudFormation returns an\n InsufficientCapabilities error.
If your stack template contains these resources, we suggest that you review all permissions associated with\n them and edit their permissions if necessary.
\n\n \n AWS::IAM::Group\n
\n\n \n AWS::IAM::Policy\n
\n\n \n AWS::IAM::Role\n
\n\n \n AWS::IAM::User\n
\nFor more information, see Acknowledging\n IAM Resources in CloudFormation Templates.
\n\n CAPABILITY_AUTO_EXPAND\n
Some template contain macros. Macros perform custom processing on templates; this can include simple actions\n like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this,\n users typically create a change set from the processed template, so that they can review the changes resulting from\n the macros before actually updating the stack. If your stack template contains one or more macros, and you choose\n to update a stack directly from the processed template, without first reviewing the resulting changes in a change\n set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless\n transforms, which are macros hosted by CloudFormation.
\nIf you want to update a stack from a stack template that contains macros and nested\n stacks, you must update the stack directly from the template using this capability.
\nYou should only update stacks directly from a stack template that contains macros if you know what processing\n the macro performs.
\nEach macro relies on an underlying Lambda service function for processing stack templates. Be\n aware that the Lambda function owner can update the function operation without CloudFormation being\n notified.
\nFor more information, see Using CloudFormation Macros\n to Perform Custom Processing on Templates.
\nThe template resource types that you have permissions to work with for this update stack\n action, such as AWS::EC2::Instance, AWS::EC2::*, or\n Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack\n update fails. By default, CloudFormation grants permissions to all resource types.\n Identity and Access Management (IAM) uses this parameter for CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with Identity and Access Management.
" + "smithy.api#documentation": "The template resource types that you have permissions to work with for this update stack action, such as\n AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By\n default, CloudFormation grants permissions to all resource types. Identity and Access Management (IAM)\n uses this parameter for CloudFormation-specific condition keys in IAM policies. For more\n information, see Controlling Access with Identity and Access Management.
" } }, "RoleARN": { "target": "com.amazonaws.cloudformation#RoleARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that\n CloudFormation assumes to update the stack. CloudFormation uses the role's\n credentials to make calls on your behalf. CloudFormation always uses this role for all\n future operations on the stack. Provided that users have permission to operate on the stack,\n CloudFormation uses this role even if the users don't have permission to pass it.\n Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously\n associated with the stack. If no role is available, CloudFormation uses a temporary\n session that is generated from your user credentials.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFormation assumes to update the stack. CloudFormation uses the role's credentials to make calls on your behalf.\n CloudFormation always uses this role for all future operations on the stack. Provided that users have\n permission to operate on the stack, CloudFormation uses this role even if the users don't have permission to\n pass it. Ensure that the role grants least privilege.
\nIf you don't specify a value, CloudFormation uses the role that was previously associated with the\n stack. If no role is available, CloudFormation uses a temporary session that is generated from your user\n credentials.
" } }, "RollbackConfiguration": { "target": "com.amazonaws.cloudformation#RollbackConfiguration", "traits": { - "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and\n updating operations, and for the specified monitoring period afterwards.
" + "smithy.api#documentation": "The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and\n for the specified monitoring period afterwards.
" } }, "StackPolicyBody": { "target": "com.amazonaws.cloudformation#StackPolicyBody", "traits": { - "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the\n StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" + "smithy.api#documentation": "Structure containing a new stack policy body. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "StackPolicyURL": { "target": "com.amazonaws.cloudformation#StackPolicyURL", "traits": { - "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy\n (max size: 16KB) located in an S3 bucket in the same Region as the stack. You can specify\n either the StackPolicyBody or the StackPolicyURL parameter, but not\n both.
You might update the stack policy, for example, in order to protect a new resource that\n you created during a stack update. If you don't specify a stack policy, the current policy\n that is associated with the stack is unchanged.
" + "smithy.api#documentation": "Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located\n in an S3 bucket in the same Region as the stack. You can specify either the StackPolicyBody or the\n StackPolicyURL parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a\n stack update. If you don't specify a stack policy, the current policy that is associated with the stack is\n unchanged.
" } }, "NotificationARNs": { "target": "com.amazonaws.cloudformation#NotificationARNs", "traits": { - "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates with the stack. Specify an empty list to remove all notification\n topics.
" + "smithy.api#documentation": "Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that CloudFormation associates\n with the stack. Specify an empty list to remove all notification topics.
" } }, "Tags": { "target": "com.amazonaws.cloudformation#Tags", "traits": { - "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these\n tags to supported resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's\n tags. If you specify an empty value, CloudFormation removes all associated\n tags.
" + "smithy.api#documentation": "Key-value pairs to associate with this stack. CloudFormation also propagates these tags to supported\n resources in the stack. You can specify a maximum number of 50 tags.
\nIf you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an\n empty value, CloudFormation removes all associated tags.
" } }, "DisableRollback": { @@ -12460,7 +12501,7 @@ "ClientRequestToken": { "target": "com.amazonaws.cloudformation#ClientRequestToken", "traits": { - "smithy.api#documentation": "A unique identifier for this UpdateStack request. Specify this token if you\n plan to retry requests so that CloudFormation knows that you're not attempting to update a\n stack with the same name. You might retry UpdateStack requests to ensure that\n CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request\n token, which you can use to track operations. For example, if you execute a\n CreateStack operation with the token token1, then all the\n StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack\n operations that are initiated from the console use the token format\n Console-StackOperation-ID, which helps you easily identify the stack\n operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests\n so that CloudFormation knows that you're not attempting to update a stack with the same name. You might retry\n UpdateStack requests to ensure that CloudFormation successfully received them.
All events triggered by a given stack operation are assigned the same client request token, which you can use to\n track operations. For example, if you execute a CreateStack operation with the token\n token1, then all the StackEvents generated by that operation will have\n ClientRequestToken set as token1.
In the console, stack operations display the client request token on the Events tab. Stack operations that are\n initiated from the console use the token format Console-StackOperation-ID, which helps you\n easily identify the stack operation . For example, if you create a stack using the console, each stack event would be\n assigned the same token in the following format:\n Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
Updates termination protection for the specified stack. If a user attempts to delete a\n stack with termination protection enabled, the operation fails and the stack remains\n unchanged. For more information, see Protecting a Stack\n From Being Deleted in the CloudFormation User Guide.
\nFor nested stacks,\n termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" + "smithy.api#documentation": "Updates termination protection for the specified stack. If a user attempts to delete a stack with termination\n protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From\n Being Deleted in the CloudFormation User Guide.
\nFor nested\n stacks, termination protection is set on the root stack and can't be changed directly on the nested\n stack.
" } }, "com.amazonaws.cloudformation#UpdateTerminationProtectionInput": { @@ -12784,7 +12825,7 @@ "StackName": { "target": "com.amazonaws.cloudformation#StackNameOrId", "traits": { - "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination\n protection.
", + "smithy.api#documentation": "The name or unique ID of the stack for which you want to set termination protection.
", "smithy.api#required": {} } } @@ -12825,7 +12866,7 @@ "target": "com.amazonaws.cloudformation#ValidateTemplateOutput" }, "traits": { - "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is\n valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both\n these checks fail, CloudFormation returns a template validation error.
" + "smithy.api#documentation": "Validates a specified template. CloudFormation first checks if the template is valid JSON. If it isn't,\n CloudFormation checks if the template is valid YAML. If both these checks fail, CloudFormation\n returns a template validation error.
" } }, "com.amazonaws.cloudformation#ValidateTemplateInput": { @@ -12834,13 +12875,13 @@ "TemplateBody": { "target": "com.amazonaws.cloudformation#TemplateBody", "traits": { - "smithy.api#documentation": "Structure containing the template body with a minimum length of 1 byte and a maximum\n length of 51,200 bytes. For more information, go to Template Anatomy in\n the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For\n more information, go to Template Anatomy in the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size:\n 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document.\n For more information, go to Template Anatomy in\n the CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both\n are passed, only TemplateBody is used.
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that\n is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the\n CloudFormation User Guide.
\nConditional: You must pass TemplateURL or TemplateBody. If both are passed, only\n TemplateBody is used.
The capabilities found within the template. If your template contains IAM\n resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this\n parameter when you use the CreateStack or UpdateStack\n actions with your template; otherwise, those actions return an InsufficientCapabilities\n error.
\nFor more information, see Acknowledging\n IAM Resources in CloudFormation Templates.
" + "smithy.api#documentation": "The capabilities found within the template. If your template contains IAM resources, you must\n specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return\n an InsufficientCapabilities error.
\nFor more information, see Acknowledging IAM\n Resources in CloudFormation Templates.
" } }, "CapabilitiesReason": { "target": "com.amazonaws.cloudformation#CapabilitiesReason", "traits": { - "smithy.api#documentation": "The list of resources that generated the values in the Capabilities response\n element.
The list of resources that generated the values in the Capabilities response element.
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.
\n For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set only to NotEquals\n kms.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail event records, the value\n must be Management or Data. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::CloudTrail::Channel\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
A field in a CloudTrail event record on which to filter events to be logged. For\n event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the field is used only for\n selecting events as filtering is not supported.
\n For CloudTrail event records, supported fields include readOnly,\n eventCategory, eventSource (for management events),\n eventName, resources.type, and resources.ARN.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, the only supported field is\n eventCategory.
\n \n readOnly\n - Optional. Can be set to\n Equals a value of true or false. If you do\n not add this field, CloudTrail logs both read and\n write events. A value of true logs only\n read events. A value of false logs only\n write events.
\n \n eventSource\n - For filtering\n management events only. This can be set only to NotEquals\n kms.amazonaws.com.
\n \n eventName\n - Can use any operator.\n You can use it to filter in or filter out any data event logged to CloudTrail,\n such as PutBucket or GetSnapshotBlock. You can have\n multiple values for this field, separated by commas.
\n \n eventCategory\n - This is required and\n must be set to Equals. \n
\n For CloudTrail event records, the value\n must be Management or Data. \n
\n For Config\n configuration items, the value must be ConfigurationItem.\n
\n For Audit Manager evidence, the value must be Evidence.\n
\n For non-Amazon Web Services events, the value must be ActivityAuditLog.\n
\n \n resources.type\n - This field is\n required for CloudTrail data events. resources.type can only\n use the Equals operator, and the value can be one of the\n following:
\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
You can have only one resources.type field per selector. To log data\n events on more than one resource type, add another selector.
\n \n resources.ARN\n - You can use any\n operator with resources.ARN, but if you use Equals or\n NotEquals, the value must exactly match the ARN of a valid resource\n of the type you've specified in the template as the value of resources.type. For\n example, if resources.type equals AWS::S3::Object, the ARN must be in\n one of the following formats. To log all data events for all objects in a specific S3\n bucket, use the StartsWith operator, and include only the bucket ARN as\n the matching value.
The trailing slash is intentional; do not exclude it. Replace the text between\n less than and greater than symbols (<>) with resource-specific information.
\n\n arn:\n
\n arn:\n
When resources.type equals AWS::DynamoDB::Table, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Lambda::Function, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CloudTrail::Channel, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::CodeWhisperer::Profile, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::Cognito::IdentityPool, and the operator is\n set to Equals or NotEquals, the ARN must be in the\n following format:
\n arn:\n
When resources.type equals AWS::DynamoDB::Stream, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
When resources.type equals AWS::EC2::Snapshot, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::EMRWAL::Workspace, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::FinSpace::Environment,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::Glue::Table, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::GuardDuty::Detector, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::KendraRanking::ExecutionPlan, and the\n operator is set to Equals or NotEquals, the ARN must be in\n the following format:
\n arn:\n
When resources.type equals AWS::ManagedBlockchain::Node,\n and the operator is set to Equals or NotEquals, the ARN\n must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::ExperimentTrialComponent, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::SageMaker::FeatureGroup, and the operator is set to\n Equals or NotEquals, the ARN must be in the following format:
\n arn:\n
When resources.type equals AWS::S3::AccessPoint, and the\n operator is set to Equals or NotEquals, the ARN must be in\n one of the following formats. To log events on all objects in an S3 access point, we\n recommend that you use only the access point ARN, don’t include the object path, and\n use the StartsWith or NotStartsWith operators.
\n arn:\n
\n arn:\n
When resources.type equals\n AWS::S3ObjectLambda::AccessPoint, and the operator is set to\n Equals or NotEquals, the ARN must be in the following\n format:
\n arn:\n
When resources.type equals AWS::S3Outposts::Object, and\n the operator is set to Equals or NotEquals, the ARN must be\n in the following format:
\n arn:\n
This is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n 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\n elements returned by the service.
\nAs an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
\nSee the CloudTrail\n User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.
\n\n Actions available for CloudTrail trails\n
\nThe following actions are available for CloudTrail trails.
\n\n AddTags\n
\n\n CreateTrail\n
\n\n DeleteTrail\n
\n\n DescribeTrails\n
\n\n GetEventSelectors\n
\n\n GetInsightSelectors\n
\n\n GetTrail\n
\n\n GetTrailStatus\n
\n\n ListTags\n
\n\n ListTrails\n
\n\n PutEventSelectors\n
\n\n PutInsightSelectors\n
\n\n RemoveTags\n
\n\n StartLogging\n
\n\n StopLogging\n
\n\n UpdateTrail\n
\n\n Actions available for CloudTrail event data stores\n
\nThe following actions are available for CloudTrail event data stores.
\n\n AddTags\n
\n\n CancelQuery\n
\n\n CreateEventDataStore\n
\n\n DeleteEventDataStore\n
\n\n DescribeQuery\n
\n\n GetEventDataStore\n
\n\n GetQueryResults\n
\n\n ListEventDataStores\n
\n\n ListTags\n
\n\n ListQueries\n
\n\n RemoveTags\n
\n\n StartImport\n
\nThe following additional actions are available for imports.
\n\n GetImport\n
\n\n ListImportFailures\n
\n\n ListImports\n
\n\n StopImport\n
\n\n StartQuery\n
\n\n UpdateEventDataStore\n
\n\n Actions available for CloudTrail channels\n
\nThe following actions are available for CloudTrail channels.
\n\n AddTags\n
\n\n CreateChannel\n
\n\n DeleteChannel\n
\n\n DeleteResourcePolicy\n
\n\n GetChannel\n
\n\n GetResourcePolicy\n
\n\n ListChannels\n
\n\n ListTags\n
\n\n PutResourcePolicy\n
\n\n RemoveTags\n
\n\n UpdateChannel\n
\n\n Actions available for managing delegated administrators\n
\nThe following actions are available for adding or a removing a delegated administrator to manage an Organizations organization’s CloudTrail resources.
\nThis is the CloudTrail API Reference. It provides descriptions of actions, data\n types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. The\n 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\n elements returned by the service.
\nAs an alternative to the API, you can use one of the Amazon Web Services SDKs, which\n consist of libraries and sample code for various programming languages and platforms\n (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the\n Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.
\nSee the CloudTrail\n User 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/" @@ -2428,7 +2428,7 @@ "target": "com.amazonaws.cloudtrail#String", "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
" + "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector$Field.
\n\n AWS::CloudTrail::Channel\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
The resource type in which you want to log data events. You can specify the following\n basic event selector resource types:
\n\n AWS::DynamoDB::Table\n
\n AWS::Lambda::Function\n
\n AWS::S3::Object\n
The following resource types are also available through advanced\n event selectors. Basic event selector resource types are valid in advanced event selectors,\n but advanced event selector resource types are not valid in basic event selectors. For more\n information, see AdvancedFieldSelector.
\n\n AWS::CloudTrail::Channel\n
\n AWS::CodeWhisperer::Profile\n
\n AWS::Cognito::IdentityPool\n
\n AWS::DynamoDB::Stream\n
\n AWS::EC2::Snapshot\n
\n AWS::EMRWAL::Workspace\n
\n AWS::FinSpace::Environment\n
\n AWS::Glue::Table\n
\n AWS::GuardDuty::Detector\n
\n AWS::KendraRanking::ExecutionPlan\n
\n AWS::ManagedBlockchain::Node\n
\n AWS::SageMaker::ExperimentTrialComponent\n
\n AWS::SageMaker::FeatureGroup\n
\n AWS::S3::AccessPoint\n
\n AWS::S3ObjectLambda::AccessPoint\n
\n AWS::S3Outposts::Object\n
Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. You must specify an ARN for\n EventDataStore, and a value for QueryID.
Returns metadata about a query, including query run time in milliseconds, number of\n events scanned and matched, and query status. If the query results were delivered to an S3 bucket, \n the response also provides the S3 URI and the delivery status.
\nYou must specify either a QueryID or a QueryAlias. Specifying\n the QueryAlias parameter returns information about the last query run for the\n alias.
The query ID.
", - "smithy.api#required": {} + "smithy.api#documentation": "The query ID.
" + } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "\n The alias that identifies a query template.\n
" } } }, @@ -4080,7 +4085,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation, and an ARN for\n EventDataStore.
Gets event data results of a query. You must specify the QueryID value\n returned by the StartQuery operation.
A SQL string of criteria about events that you want to collect in an event data\n store.
" } }, + "com.amazonaws.cloudtrail#QueryAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9._\\-]*$" + } + }, "com.amazonaws.cloudtrail#QueryIdNotFoundException": { "type": "structure", "members": { @@ -6968,6 +6983,28 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudtrail#QueryParameter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.cloudtrail#QueryParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.cloudtrail#QueryResultColumn": { "type": "map", "key": { @@ -8061,7 +8098,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a CloudTrail Lake query. The required QueryStatement\n parameter provides your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.
Starts a CloudTrail Lake query. Use the QueryStatement\n parameter to provide your SQL query, enclosed in single quotation marks. Use the optional\n DeliveryS3Uri parameter to deliver the query results to an S3\n bucket.
\n StartQuery requires you specify either the QueryStatement parameter, or a QueryAlias and any QueryParameters. In the current release, \n the QueryAlias and QueryParameters parameters are used only for the queries that populate the CloudTrail Lake dashboards.
The SQL code of your query.
", - "smithy.api#required": {} + "smithy.api#documentation": "The SQL code of your query.
" } }, "DeliveryS3Uri": { @@ -8080,6 +8116,18 @@ "traits": { "smithy.api#documentation": "The URI for the S3 bucket where CloudTrail delivers the query results.
" } + }, + "QueryAlias": { + "target": "com.amazonaws.cloudtrail#QueryAlias", + "traits": { + "smithy.api#documentation": "\n The alias that identifies a query template.\n
" + } + }, + "QueryParameters": { + "target": "com.amazonaws.cloudtrail#QueryParameters", + "traits": { + "smithy.api#documentation": "\n The query parameters for the specified QueryAlias.\n
This field is no longer in use. Use SnsTopicARN.
" + "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 90 and\n 2557. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management and data events in your event data store. For more\n information about AdvancedEventSelectors, see PutEventSelectorsRequest$AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
Updates an event data store. The required EventDataStore value is an ARN or\n the ID portion of the ARN. Other parameters are optional, but at least one optional\n parameter must be specified, or CloudTrail throws an error.\n RetentionPeriod is in days, and valid values are integers between 90 and\n 2557. By default, TerminationProtection is enabled.
For event data stores for CloudTrail events, AdvancedEventSelectors\n includes or excludes management and data events in your event data store. For more\n information about AdvancedEventSelectors, see \n AdvancedEventSelectors.
For event data stores for Config configuration items, Audit Manager evidence, or non-Amazon Web Services events,\n AdvancedEventSelectors includes events of that type in your event data store.
This field is no longer in use. Use UpdateTrailResponse$SnsTopicARN.
" + "smithy.api#documentation": "This field is no longer in use. Use SnsTopicARN.
The name of the account policy.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "The policy document for this account policy.
\nThe JSON specified in policyDocument can be up to 30,720 characters.
The date and time that this policy was most recently updated.
" + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "The type of policy for this account policy.
" + } + }, + "scope": { + "target": "com.amazonaws.cloudwatchlogs#Scope", + "traits": { + "smithy.api#documentation": "The scope of the account policy.
" + } + }, + "accountId": { + "target": "com.amazonaws.cloudwatchlogs#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that the policy applies to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about one CloudWatch Logs account policy.
" + } + }, + "com.amazonaws.cloudwatchlogs#AccountPolicyDocument": { + "type": "string" + }, "com.amazonaws.cloudwatchlogs#AmazonResourceName": { "type": "string", "traits": { @@ -115,6 +168,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#CancelExportTask": { @@ -153,6 +209,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#CreateExportTask": { @@ -236,6 +295,9 @@ "smithy.api#documentation": "The prefix used as the start of the key for every object exported. If you don't\n specify a value, the default is exportedlogs.
The ID of the export task.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#CreateLogGroup": { @@ -275,7 +340,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a log group with the specified name. You can create up to 20,000 log groups per account.
\nYou must use the following guidelines when naming a log group:
\nLog group names must be unique within a Region for an Amazon Web Services\n account.
\nLog group names can be between 1 and 512 characters long.
\nLog group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)
\nWhen you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.
\nIf you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.
\nIf you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.
\nCreates a log group with the specified name. You can create up to 20,000 log groups per account.
\nYou must use the following guidelines when naming a log group:
\nLog group names must be unique within a Region for an Amazon Web Services\n account.
\nLog group names can be between 1 and 512 characters long.
\nLog group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), \n '/' (forward slash), '.' (period), and '#' (number sign)
\nWhen you create a log group, by default the log events in the log group do not expire.\n To set a retention policy so that events expire and are deleted after a specified time, use\n PutRetentionPolicy.
\nIf you associate an KMS key with the log group, ingested data is\n encrypted using the KMS key. This association is stored as long as the data\n encrypted with the KMS key is still within CloudWatch Logs. This enables\n CloudWatch Logs to decrypt this data whenever it is requested.
\nIf you attempt to associate a KMS key with the log group but the KMS key does not exist or the KMS key is disabled, you receive an\n InvalidParameterException error.
CloudWatch Logs supports only symmetric KMS keys. Do not associate an\n asymmetric KMS key with your log group. For more information, see Using\n Symmetric and Asymmetric Keys.
\nThe key-value pairs to use for the tags.
\nYou can grant users access to certain log groups while preventing them from accessing other log groups.\n To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when \n you create a log group, you must have either the logs:TagResource or logs:TagLogGroup\n permission. For more information about tagging, see \n Tagging Amazon Web Services resources.\n For more information about using tags to control access, see \n Controlling access to Amazon Web Services resources using tags.
The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.
\nTo set a log group so that its log events do not expire, use DeleteRetentionPolicy.
" + "smithy.api#documentation": "The number of days to retain the log events in the specified log group.\n Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.
\nTo set a log group so that its log events do not expire, use DeleteRetentionPolicy.
" } }, "com.amazonaws.cloudwatchlogs#DefaultValue": { "type": "double" }, + "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a CloudWatch Logs account policy.
\nTo use this operation, you must be signed on with the logs:DeleteDataProtectionPolicy and \n logs:DeleteAccountPolicy permissions.
The name of the policy to delete.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "The type of policy to delete. Currently, the only valid value is DATA_PROTECTION_POLICY.
A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation\n failed.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#DeleteResourcePolicy": { @@ -686,6 +826,9 @@ "smithy.api#documentation": "The name of the policy to be revoked. This parameter is required.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DeleteRetentionPolicy": { @@ -724,6 +867,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter": { @@ -769,11 +915,81 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#Descending": { "type": "boolean" }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all CloudWatch Logs account policies in the account.
" + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesRequest": { + "type": "structure", + "members": { + "policyType": { + "target": "com.amazonaws.cloudwatchlogs#PolicyType", + "traits": { + "smithy.api#documentation": "Use this parameter to limit the returned policies to only the policies that match the policy type that you\n specify. Currently, the only valid value is DATA_PROTECTION_POLICY.
Use this parameter to limit the returned policies to only the policy with the name that you specify.
" + } + }, + "accountIdentifiers": { + "target": "com.amazonaws.cloudwatchlogs#AccountIds", + "traits": { + "smithy.api#documentation": "If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account\n observability, you can use this to specify the account ID of a source account. If you do, \n the operation returns the account policy for the specified account. Currently, you can specify only\n one account ID in this parameter.
\nIf you\n omit this parameter, only the policy in the current account is returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.cloudwatchlogs#DescribeAccountPoliciesResponse": { + "type": "structure", + "members": { + "accountPolicies": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicies", + "traits": { + "smithy.api#documentation": "An array of structures that contain information about the CloudWatch Logs account policies that match \n the specified filters.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatchlogs#DescribeDestinations": { "type": "operation", "input": { @@ -821,6 +1037,9 @@ "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default maximum value of \n 50 items is used.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DescribeDestinationsResponse": { @@ -835,6 +1054,9 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#DescribeExportTasks": { @@ -884,6 +1106,9 @@ "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DescribeExportTasksResponse": { @@ -898,6 +1123,9 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#DescribeLimit": { @@ -953,7 +1181,7 @@ "logGroupNamePattern": { "target": "com.amazonaws.cloudwatchlogs#LogGroupNamePattern", "traits": { - "smithy.api#documentation": "If you specify a string for this parameter, the operation returns only log groups that have names\nthat match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups\nnamed FooBar, aws/Foo, and GroupFoo would match, but foo, \nF/o/o and Froo would not match.
\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive. \n Only one \n of these parameters can be passed.\n
If you specify a string for this parameter, the operation returns only log groups that have names\nthat match the string based on a case-sensitive substring search. For example, if you specify Foo, log groups\nnamed FooBar, aws/Foo, and GroupFoo would match, but foo, \nF/o/o and Froo would not match.
If you specify logGroupNamePattern in your request, then only\n arn, creationTime, and logGroupName\n are included in the response.
\n logGroupNamePattern and logGroupNamePrefix are mutually exclusive. \n Only one \n of these parameters can be passed.\n
If you are using a monitoring account, set this to True to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
If you specify includeLinkedAccounts in your request, then\n metricFilterCount, retentionInDays, and storedBytes\n are not included in the response.
If you are using a monitoring account, set this to True to have the operation\n return log groups in \n the accounts listed in accountIdentifiers.
If this parameter is set to true and accountIdentifiers\n\n contains a null value, the operation returns all log groups in the monitoring account\n and all log groups in all source accounts that are linked to the monitoring account.
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DescribeLogStreamsResponse": { @@ -1078,6 +1315,9 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#DescribeMetricFilters": { @@ -1148,6 +1388,9 @@ "smithy.api#documentation": "Filters results to include only those in the specified namespace. If you include this parameter in your request, you \n must also include the metricName parameter.
The maximum number of resource policies to be displayed with one call of this API.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DescribeResourcePoliciesResponse": { @@ -1336,6 +1597,9 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFilters": { @@ -1395,6 +1659,9 @@ "smithy.api#documentation": "The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#DescribeSubscriptionFiltersResponse": { @@ -1409,6 +1676,9 @@ "nextToken": { "target": "com.amazonaws.cloudwatchlogs#NextToken" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#Destination": { @@ -1542,6 +1812,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#Distribution": { @@ -1807,7 +2080,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.
\nYou must have the logs;FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events) or all the events found within the specified time range. If the results include a\n token, that means there are more log events available. You can get additional results by\n specifying the token in a subsequent call. This operation can return empty results while there\n are more log events available through the token.
\nThe returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", + "smithy.api#documentation": "Lists log events from the specified log group. You can list all the log events or filter the results\n using a filter pattern, a time range, and the name of the log stream.
\nYou must have the logs:FilterLogEvents permission to perform this operation.
You can specify the log group to search by using either logGroupIdentifier or logGroupName.\n You must include one of these two parameters, but you can't include both.\n
By default, this operation returns as many log events as can fit in 1 MB (up to 10,000\n log events) or all the events found within the specified time range. If the results include a\n token, that means there are more log events available. You can get additional results by\n specifying the token in a subsequent call. This operation can return empty results while there\n are more log events available through the token.
\nThe returned log events are sorted by event timestamp, the timestamp when the event was ingested\n by CloudWatch Logs, and the ID of the PutLogEvents request.
If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and \n view data from the linked source accounts. For more information, see \n CloudWatch cross-account observability.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -1888,6 +2161,9 @@ "smithy.api#documentation": "Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The token to use when requesting the next set of items. The token expires after 24 hours.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#FilterName": { @@ -2016,6 +2295,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#GetDataProtectionPolicyResponse": { @@ -2039,6 +2321,9 @@ "smithy.api#documentation": "The date and time that this policy was most recently updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#GetLogEvents": { @@ -2129,6 +2414,9 @@ "smithy.api#documentation": "Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The token for the next set of items in the backward direction. The token expires after\n 24 hours. This token is not null. If you have reached the end of the stream, it returns the\n same token you passed in.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#GetLogGroupFields": { @@ -2201,6 +2492,9 @@ "smithy.api#documentation": "Specify either the name or ARN of the log group to view. If the log group is in a source account and\n you are using a monitoring account, you must specify the ARN.
\n\n You must include either logGroupIdentifier or logGroupName, but not \n both.\n
The array of fields found in the query. Each object in the array contains the name of the\n field, along with the percentage of time it appeared in the log events that were\n queried.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#GetLogRecord": { @@ -2257,6 +2554,9 @@ "smithy.api#documentation": "Specify true to display the log event fields with all sensitive data unmasked and visible.\n The default is false.
To use this operation with this parameter, you must be signed into an account with the logs:Unmask\n permission.
The requested log event, as a JSON string.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#GetQueryResults": { @@ -2303,6 +2606,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#GetQueryResultsResponse": { @@ -2323,14 +2629,34 @@ "status": { "target": "com.amazonaws.cloudwatchlogs#QueryStatus", "traits": { - "smithy.api#documentation": "The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.
Queries time out after 15 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.
" + "smithy.api#documentation": "The status of the most recent running of the query. Possible values are Cancelled, \n Complete, Failed, Running, Scheduled, \n Timeout, and Unknown.
Queries time out after 60 minutes of runtime. To avoid having your queries time out,\n reduce the time range being searched or partition your query into a number of queries.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#IncludeLinkedAccounts": { "type": "boolean" }, + "com.amazonaws.cloudwatchlogs#InheritedProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperty" + } + }, + "com.amazonaws.cloudwatchlogs#InheritedProperty": { + "type": "enum", + "members": { + "ACCOUNT_DATA_PROTECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_DATA_PROTECTION" + } + } + } + }, "com.amazonaws.cloudwatchlogs#InputLogEvent": { "type": "structure", "members": { @@ -2344,7 +2670,7 @@ "message": { "target": "com.amazonaws.cloudwatchlogs#EventMessage", "traits": { - "smithy.api#documentation": "The raw event message.
", + "smithy.api#documentation": "The raw event message. Each log event can be no larger than 256 KB.
", "smithy.api#required": {} } } @@ -2473,6 +2799,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#ListTagsForResourceResponse": { @@ -2484,6 +2813,9 @@ "smithy.api#documentation": "The list of tags associated with the requested resource.>
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#ListTagsLogGroup": { @@ -2523,7 +2855,8 @@ "traits": { "smithy.api#deprecated": { "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" - } + }, + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#ListTagsLogGroupResponse": { @@ -2539,7 +2872,8 @@ "traits": { "smithy.api#deprecated": { "message": "Please use the generic tagging API model ListTagsForResourceRequest and ListTagsForResourceResponse" - } + }, + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#LogEventIndex": { @@ -2592,6 +2926,12 @@ "traits": { "smithy.api#documentation": "Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see \n PutDataProtectionPolicy.
" } + }, + "inheritedProperties": { + "target": "com.amazonaws.cloudwatchlogs#InheritedProperties", + "traits": { + "smithy.api#documentation": "Displays all the properties that this log group has inherited from account-level \n settings.
" + } } }, "traits": { @@ -2782,6 +3122,9 @@ { "target": "com.amazonaws.cloudwatchlogs#CreateLogStream" }, + { + "target": "com.amazonaws.cloudwatchlogs#DeleteAccountPolicy" + }, { "target": "com.amazonaws.cloudwatchlogs#DeleteDataProtectionPolicy" }, @@ -2809,6 +3152,9 @@ { "target": "com.amazonaws.cloudwatchlogs#DeleteSubscriptionFilter" }, + { + "target": "com.amazonaws.cloudwatchlogs#DescribeAccountPolicies" + }, { "target": "com.amazonaws.cloudwatchlogs#DescribeDestinations" }, @@ -2863,6 +3209,9 @@ { "target": "com.amazonaws.cloudwatchlogs#ListTagsLogGroup" }, + { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicy" + }, { "target": "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy" }, @@ -4271,6 +4620,92 @@ "com.amazonaws.cloudwatchlogs#PolicyName": { "type": "string" }, + "com.amazonaws.cloudwatchlogs#PolicyType": { + "type": "enum", + "members": { + "DATA_PROTECTION_POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_PROTECTION_POLICY" + } + } + } + }, + "com.amazonaws.cloudwatchlogs#PutAccountPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyRequest" + }, + "output": { + "target": "com.amazonaws.cloudwatchlogs#PutAccountPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudwatchlogs#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#LimitExceededException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#OperationAbortedException" + }, + { + "target": "com.amazonaws.cloudwatchlogs#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an account-level data protection policy that applies to all log groups in the account. A data protection policy can help safeguard sensitive \n data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only\n one account-level policy.
\nSensitive data is detected and masked when it is ingested into a log group. When you set a \n data protection policy, log events ingested into the log groups before that time are not masked.
\nIf you use PutAccountPolicy to create a data protection policy for your whole account, it applies to both existing log groups\n and all log groups that are created later in this account. The account policy is applied to existing log groups\n with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.
By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nTo use the PutAccountPolicy operation, you must be signed on with the logs:PutDataProtectionPolicy\n and logs:PutAccountPolicy permissions.
The PutAccountPolicy operation applies to all log groups in the account. You can also use \n PutDataProtectionPolicy\n to create a data protection policy that applies to just one log group. \n If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
A name for the policy. This must be unique within the account.
", + "smithy.api#required": {} + } + }, + "policyDocument": { + "target": "com.amazonaws.cloudwatchlogs#AccountPolicyDocument", + "traits": { + "smithy.api#documentation": "Specify the data protection policy, in JSON.
\nThis policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Kinesis Data Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is different than the \n operation's policyName parameter, and is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters.
Currently the only valid value for this parameter is DATA_PROTECTION_POLICY.
Currently the only valid value for this parameter is GLOBAL, which specifies that the data \n protection policy applies to all log groups in the account. If you omit this parameter, the default\n of GLOBAL is used.
The account policy that you created.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.cloudwatchlogs#PutDataProtectionPolicy": { "type": "operation", "input": { @@ -4297,7 +4732,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive \n data that's ingested by the log group by auditing and masking the sensitive log data.
\nSensitive data is detected and masked when it is ingested into the log group. When you set a \n data protection policy, log events ingested into the log group before that time are not masked.
\nBy default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
" + "smithy.api#documentation": "Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive \n data that's ingested by the log group by auditing and masking the sensitive log data.
\nSensitive data is detected and masked when it is ingested into the log group. When you set a \n data protection policy, log events ingested into the log group before that time are not masked.
\nBy default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.\n A user who has the logs:Unmask permission can use a \n GetLogEvents or \n FilterLogEvents\n operation with the unmask parameter set to true to view the unmasked \n log events. Users with the logs:Unmask can also view unmasked data in the CloudWatch Logs\n console by running a CloudWatch Logs Insights query with the unmask query command.
For more information, including a list of types of data that can be audited and masked, see\n Protect sensitive log data with masking.
\nThe PutDataProtectionPolicy operation applies to only the specified log group. You can also use \n PutAccountPolicy\n to create an account-level data protection policy that applies to all log groups in the account, \n including both existing log groups and log groups that are created level. If a log group has its own data protection policy and \n the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term\n specified in either policy is masked.
Specify the data protection policy, in JSON.
\nThis policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Kinesis Data Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of two DataIdentifer arrays must match exactly.
Specify the data protection policy, in JSON.
\nThis policy must include two JSON blocks:
\nThe first block must include both a DataIdentifer array and an \n Operation property with an Audit action. The DataIdentifer array lists the types of sensitive data that\n you want to mask. For more information about the available options, see \n Types of data that you can mask.
The Operation property with an Audit action is required to find the \n sensitive data terms. This Audit action must contain a FindingsDestination\n object. You can optionally use that FindingsDestination object to list one or more \n destinations to send audit findings to. If you specify destinations such as log groups, \n Kinesis Data Firehose streams, and S3 buckets, they must already exist.
The second block must include both a DataIdentifer array and an\n Operation property with an Deidentify action. The\n DataIdentifer array must exactly match the DataIdentifer array\n in the first block of the policy.
The Operation property with the Deidentify action is what actually masks the \n data, and it must \n contain the \n \"MaskConfig\": {} object. The \n \"MaskConfig\": {} object must be empty.
For an example data protection policy, see the Examples section on this page.
\nThe contents of the two DataIdentifer arrays must match exactly.
In addition to the two JSON blocks, the policyDocument can also include Name,\n Description, and Version fields. The Name is used as a dimension when\n CloudWatch Logs reports audit findings metrics to CloudWatch.
The JSON specified in policyDocument can be up to 30,720 characters.
The date and time that this policy was most recently updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#PutDestination": { @@ -4408,9 +4849,12 @@ "forceUpdate": { "target": "com.amazonaws.cloudwatchlogs#ForceUpdate", "traits": { - "smithy.api#documentation": "Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual AWS accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n
If you omit this parameter, the default of false is used.
Specify true if you are updating an existing destination policy to grant permission to\n an organization ID instead of granting permission to individual Amazon Web Services accounts. Before\n you update a destination policy this way, you must first update the subscription\n filters in the accounts that send logs to this destination. If you do not, the subscription\n filters might stop working. By specifying true\n for forceUpdate, you are affirming that you have already updated the subscription \n filters.\n For more information, see \n Updating an existing cross-account subscription\n
If you omit this parameter, the default of false is used.
An optional list of key-value pairs to associate with the resource.
\nFor more information about tagging, see \n Tagging Amazon Web Services resources\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#PutDestinationResponse": { @@ -4454,6 +4901,9 @@ "smithy.api#documentation": "The destination.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#PutLogEvents": { @@ -4485,7 +4935,7 @@ } ], "traits": { - "smithy.api#documentation": "Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
Uploads a batch of log events to the specified log stream.
\nThe sequence token is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are always accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid. You can use\n parallel PutLogEvents actions on the same log stream.
The batch of events must satisfy the following constraints:
\nThe maximum batch size is 1,048,576 bytes. This size is calculated as the sum of\n all event messages in UTF-8, plus 26 bytes for each log event.
\nNone of the log events in the batch can be more than 2 hours in the future.
\nNone of the log events in the batch can be more than 14 days in the past. Also,\n none of the log events can be from earlier than the retention period of the log\n group.
\nThe log events in the batch must be in chronological order by their timestamp. The\n timestamp is the time that the event occurred, expressed as the number of milliseconds\n after Jan 1, 1970 00:00:00 UTC. (In Amazon Web Services Tools for PowerShell\n and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:\n yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
\nEach log event can be no larger than 256 KB.
\nThe maximum number of log events in a batch is 10,000.
\nThe quota of five requests per second per log stream\n has been removed. Instead, PutLogEvents actions are throttled based on a \n per-second per-account quota. You can request an increase to the per-second throttling\n quota by using the Service Quotas service.
If a call to PutLogEvents returns \"UnrecognizedClientException\" the most\n likely cause is a non-valid Amazon Web Services access key ID or secret key.
The sequence token obtained from the response of the previous PutLogEvents\n call.
The sequenceToken parameter is now ignored in PutLogEvents\n actions. PutLogEvents\n actions are now accepted and never return InvalidSequenceTokenException or\n DataAlreadyAcceptedException even if the sequence token is not valid.
The rejected events.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#PutMetricFilter": { @@ -4597,6 +5053,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#PutQueryDefinition": { @@ -4654,6 +5113,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#PutQueryDefinitionResponse": { @@ -4665,6 +5127,9 @@ "smithy.api#documentation": "The ID of the query definition.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#PutResourcePolicy": { @@ -4705,6 +5170,9 @@ "smithy.api#documentation": "Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.\n This parameter is required.
\nThe following example creates a resource policy enabling the Route 53 service to put\n DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of \n your CloudWatch Logs resource, such as a log group or log stream.
CloudWatch Logs also supports aws:SourceArn\n and aws:SourceAccount\ncondition context keys.
\nIn the example resource policy, you would replace the value of SourceArn with\n the resource making the call from Route 53 to CloudWatch Logs. You would also\n replace the value of SourceAccount with the Amazon Web Services account ID making\n that call.
\n {\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Sid\": \"Route53LogsToCloudWatchLogs\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"Service\": [\n \"route53.amazonaws.com\"\n ]\n },\n \"Action\": \"logs:PutLogEvents\",\n \"Resource\": \"logArn\",\n \"Condition\": {\n \"ArnLike\": {\n \"aws:SourceArn\": \"myRoute53ResourceArn\"\n },\n \"StringEquals\": {\n \"aws:SourceAccount\": \"myAwsAccountId\"\n }\n }\n }\n ]\n}\n
The new policy.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#PutRetentionPolicy": { @@ -4760,6 +5231,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#PutSubscriptionFilter": { @@ -4788,7 +5262,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.
\nA logical destination that belongs to a different account, for cross-account delivery.
\nAn Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.
\nAn Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.
\nEach log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n
To perform a PutSubscriptionFilter operation, you must also have the \n iam:PassRole permission.
Creates or updates a subscription filter and associates it with the specified log\n group. With subscription filters, you can subscribe to a real-time stream of log events\n ingested through PutLogEvents\n and have them delivered to a specific destination. When log events are sent to the receiving\n service, they are Base64 encoded and compressed with the GZIP format.
\nThe following destinations are supported for subscription filters:
\nAn Amazon Kinesis data stream belonging to the same account as the subscription\n filter, for same-account delivery.
\nA logical destination that belongs to a different account, for cross-account delivery.
\nAn Amazon Kinesis Data Firehose delivery stream that belongs to the same account as\n the subscription filter, for same-account delivery.
\nAn Lambda function that belongs to the same account as the\n subscription filter, for same-account delivery.
\nEach log group can have up to two subscription filters associated with it. If you are\n updating an existing filter, you must specify the correct name in filterName.\n
To perform a PutSubscriptionFilter operation for any destination except a Lambda function, \n you must also have the \n iam:PassRole permission.
The method used to distribute log data to the destination. By default, log data is\n grouped by log stream, but the grouping can be set to random for a more even distribution.\n This property is only applicable when the destination is an Amazon Kinesis data stream.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#QueryCharOffset": { @@ -5210,6 +5687,17 @@ } } }, + "com.amazonaws.cloudwatchlogs#Scope": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, "com.amazonaws.cloudwatchlogs#SearchedLogStream": { "type": "structure", "members": { @@ -5452,7 +5940,7 @@ } ], "traits": { - "smithy.api#documentation": "Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.
\nFor more information, see CloudWatch Logs Insights Query Syntax.
\nQueries time out after 15 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.
You can have up to 20 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.
" + "smithy.api#documentation": "Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group\n and time range to query and the query string to use.
\nFor more information, see CloudWatch Logs Insights Query Syntax.
\nQueries time out after 60 minutes of runtime. If your queries are timing out, reduce the\n time range being searched or partition your query into a number of queries.
\nIf you are using CloudWatch cross-account observability, you can use this operation in a\n monitoring account to start a query in a linked source account. For more information, see\n CloudWatch\n cross-account observability. For a cross-account StartQuery operation,\n the query definition must be defined in the monitoring account.
You can have up to 30 concurrent CloudWatch Logs insights queries, including queries\n that have been added to dashboards.
" } }, "com.amazonaws.cloudwatchlogs#StartQueryRequest": { @@ -5503,6 +5991,9 @@ "smithy.api#documentation": "The maximum number of log events to return in the query. If the query string uses the fields command,\n only the specified fields and their values are returned. The default is 1000.
The unique ID of the query.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#StatsValue": { @@ -5555,6 +6049,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#StopQueryResponse": { @@ -5567,6 +6064,9 @@ "smithy.api#documentation": "This is true if the query was stopped by the StopQuery operation.
The matched events.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.cloudwatchlogs#Timestamp": { @@ -5941,7 +6451,8 @@ "traits": { "smithy.api#deprecated": { "message": "Please use the generic tagging API model UntagResourceRequest" - } + }, + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#UntagResource": { @@ -5984,6 +6495,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.cloudwatchlogs#Value": { diff --git a/codegen/sdk-codegen/aws-models/codeguru-security.2018-05-10.json b/codegen/sdk-codegen/aws-models/codeguru-security.2018-05-10.json new file mode 100644 index 00000000000..d9a0416ab6a --- /dev/null +++ b/codegen/sdk-codegen/aws-models/codeguru-security.2018-05-10.json @@ -0,0 +1,3017 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.codegurusecurity#AccessDeniedException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the resource you don't have access to.
" + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of resource you don't have access to.
" + } + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.codegurusecurity#AccountFindingsMetric": { + "type": "structure", + "members": { + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date from which the finding metrics were retrieved.
" + } + }, + "newFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "The number of new findings of each severity in account on the specified date.
" + } + }, + "closedFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "The number of closed findings of each severity in an account on the specified date.
" + } + }, + "openFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "The number of open findings of each severity in an account as of the specified date.
" + } + }, + "meanTimeToClose": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "The average time it takes to close findings of each severity in days.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of findings metrics in an account.
" + } + }, + "com.amazonaws.codegurusecurity#AnalysisType": { + "type": "enum", + "members": { + "SECURITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Security" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, + "com.amazonaws.codegurusecurity#AwsCodeGuruSecurity": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.codegurusecurity#BatchGetFindings" + }, + { + "target": "com.amazonaws.codegurusecurity#CreateScan" + }, + { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrl" + }, + { + "target": "com.amazonaws.codegurusecurity#GetAccountConfiguration" + }, + { + "target": "com.amazonaws.codegurusecurity#GetFindings" + }, + { + "target": "com.amazonaws.codegurusecurity#GetMetricsSummary" + }, + { + "target": "com.amazonaws.codegurusecurity#GetScan" + }, + { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetrics" + }, + { + "target": "com.amazonaws.codegurusecurity#ListScans" + }, + { + "target": "com.amazonaws.codegurusecurity#ListTagsForResource" + }, + { + "target": "com.amazonaws.codegurusecurity#TagResource" + }, + { + "target": "com.amazonaws.codegurusecurity#UntagResource" + }, + { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfiguration" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "CodeGuru Security", + "arnNamespace": "codeguru-security", + "cloudTrailEventSource": "codeguru-security.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "codeguru-security" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Authorization", + "Content-Type", + "Credentials", + "X-Amz-Date", + "X-Api-Key", + "X-Amz-Security-Token", + "x-amz-content-sha256", + "X-Amz-User-Agent" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-errormessage", + "x-amzn-trace-id", + "x-amz-apigw-id", + "date" + ], + "origin": "*" + }, + "smithy.api#documentation": "This section provides documentation for the Amazon CodeGuru Security API operations.\n CodeGuru Security is a service that uses program analysis and machine learning to detect\n security policy violations and vulnerabilities, and recommends ways to address these security\n risks.
\nBy proactively detecting and providing recommendations for addressing security risks,\n CodeGuru Security improves the overall security of your application code. For more information\n about CodeGuru Security, see the \n Amazon CodeGuru Security User Guide.
", + "smithy.api#title": "Amazon CodeGuru Security", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://codeguru-security.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-gov-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-gov-east-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "cn-north-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-iso-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-east-1.api.aws" + } + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-east-1.amazonaws.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseDualStack": true, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://codeguru-security.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-isob-east-1" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindings": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all requested findings.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/batchGetFindings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsError": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The name of the scan that generated the finding.
", + "smithy.api#required": {} + } + }, + "findingId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The finding ID of the finding that was not fetched.
", + "smithy.api#required": {} + } + }, + "errorCode": { + "target": "com.amazonaws.codegurusecurity#ErrorCode", + "traits": { + "smithy.api#documentation": "A code associated with the type of error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Describes the error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the error that caused a finding to fail to be retrieved.
" + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsError" + } + }, + "com.amazonaws.codegurusecurity#BatchGetFindingsRequest": { + "type": "structure", + "members": { + "findingIdentifiers": { + "target": "com.amazonaws.codegurusecurity#FindingIdentifiers", + "traits": { + "smithy.api#documentation": "A list of finding identifiers. Each identifier consists of a scanName and a\n findingId. You retrieve the findingId when you call\n GetFindings.
A list of all requested findings.
", + "smithy.api#required": {} + } + }, + "failedFindings": { + "target": "com.amazonaws.codegurusecurity#BatchGetFindingsErrors", + "traits": { + "smithy.api#documentation": "A list of errors for individual findings which were not fetched. Each\n BatchGetFindingsError contains the scanName, findingId,\n errorCode and error message.
The name of the finding category. A finding category is determined by the detector that\n detected the finding.
" + } + }, + "findingNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of open findings in the category.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a finding category with open findings.
" + } + }, + "com.amazonaws.codegurusecurity#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.codegurusecurity#CodeLine": { + "type": "structure", + "members": { + "number": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The code line number.
" + } + }, + "content": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The code that contains a vulnerability.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The line of code where a finding was detected.
" + } + }, + "com.amazonaws.codegurusecurity#CodeSnippet": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#CodeLine" + } + }, + "com.amazonaws.codegurusecurity#ConflictException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the service resource associated with the request.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of resource associated with the request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.codegurusecurity#CreateScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#CreateScanRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#CreateScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to create a scan using code uploaded to an S3 bucket.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/scans" + } + } + }, + "com.amazonaws.codegurusecurity#CreateScanRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.codegurusecurity#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent\n the accidental creation of duplicate scans if there are failures and retries.
", + "smithy.api#idempotencyToken": {} + } + }, + "resourceId": { + "target": "com.amazonaws.codegurusecurity#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier for an input resource used to create a scan.
", + "smithy.api#required": {} + } + }, + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The unique name that CodeGuru Security uses to track revisions across multiple\n scans of the same resource. Only allowed for a STANDARD scan type. If not\n specified, it will be auto generated.
The type of scan, either Standard or Express. Defaults to\n Standard type if missing.
\n Express scans run on limited resources and use a limited set of detectors to\n analyze your code in near-real time. Standard scans have standard resource limits\n and use the full set of detectors to analyze your code.
The type of analysis you want CodeGuru Security to perform in the scan, either\n Security or All. The Secuirty type only generates\n findings related to security. The All type generates both security findings and\n quality findings. Defaults to Security type if missing.
An array of key-value pairs used to tag a scan. A tag is a custom attribute\n label with two parts:
\nA tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.
The name of the scan.
", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "UUID that identifies the individual scan run.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "com.amazonaws.codegurusecurity#ResourceId", + "traits": { + "smithy.api#documentation": "The identifier for the resource object that contains resources that were scanned.
", + "smithy.api#required": {} + } + }, + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "The current state of the scan. Returns either InProgress,\n Successful, or Failed.
The ARN for the scan name.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#CreateUploadUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrlRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#CreateUploadUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a pre-signed URL and request headers used to upload a code resource.
\nYou can upload your code resource to the URL and add the request headers using any HTTP\n client.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/uploadUrl" + } + } + }, + "com.amazonaws.codegurusecurity#CreateUploadUrlRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The name of the scan that will use the uploaded resource. CodeGuru Security uses the\n unique scan name to track revisions across multiple scans of the same resource. Use this \n scanName when you call CreateScan on the code resource you upload to this URL.
A pre-signed S3 URL. You can upload the code file you want to scan and add the required\n requestHeaders using any HTTP client.
A set of key-value pairs that contain the required headers when uploading your\n resource.
", + "smithy.api#required": {} + } + }, + "codeArtifactId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "The identifier for the uploaded code resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#DetectorTags": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#EncryptionConfig": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.codegurusecurity#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key ARN to use for encryption. This must be provided as a header when uploading\n your code resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about account-level configuration.
" + } + }, + "com.amazonaws.codegurusecurity#ErrorCode": { + "type": "enum", + "members": { + "DUPLICATE_IDENTIFIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_IDENTIFIER" + } + }, + "ITEM_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITEM_DOES_NOT_EXIST" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "INVALID_FINDING_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_FINDING_ID" + } + }, + "INVALID_SCAN_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SCAN_NAME" + } + } + } + }, + "com.amazonaws.codegurusecurity#FilePath": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the file.
" + } + }, + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The path to the resource with the security vulnerability.
" + } + }, + "startLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The first line number of the code snippet where the security vulnerability appears in your code.
" + } + }, + "endLine": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The last line number of the code snippet where the security vulnerability appears in your\n code.
" + } + }, + "codeSnippet": { + "target": "com.amazonaws.codegurusecurity#CodeSnippet", + "traits": { + "smithy.api#documentation": "A list of CodeLine objects that describe where the security vulnerability\n appears in your code.
Information about the location of security vulnerabilities that Amazon CodeGuru Security\n detected in your code.
" + } + }, + "com.amazonaws.codegurusecurity#Finding": { + "type": "structure", + "members": { + "createdAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the finding was created.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the finding.
" + } + }, + "generatorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the component that generated a finding such as AWSCodeGuruSecurity or\n AWSInspector.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for a finding.
" + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the finding was last updated. Findings are updated when you remediate them\n or when the finding code location changes.
" + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of finding.
" + } + }, + "status": { + "target": "com.amazonaws.codegurusecurity#Status", + "traits": { + "smithy.api#documentation": "The status of the finding. A finding status can be open or closed.
" + } + }, + "resource": { + "target": "com.amazonaws.codegurusecurity#Resource", + "traits": { + "smithy.api#documentation": "The resource where Amazon CodeGuru Security detected a finding.
" + } + }, + "vulnerability": { + "target": "com.amazonaws.codegurusecurity#Vulnerability", + "traits": { + "smithy.api#documentation": "An object that describes the detected security vulnerability.
" + } + }, + "severity": { + "target": "com.amazonaws.codegurusecurity#Severity", + "traits": { + "smithy.api#documentation": "The severity of the finding.
" + } + }, + "remediation": { + "target": "com.amazonaws.codegurusecurity#Remediation", + "traits": { + "smithy.api#documentation": "An object that contains the details about how to remediate a finding.
" + } + }, + "title": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The title of the finding.
" + } + }, + "detectorTags": { + "target": "com.amazonaws.codegurusecurity#DetectorTags", + "traits": { + "smithy.api#documentation": "One or more tags or categorizations that are associated with a detector. These tags are\n defined by type, programming language, or other classification such as maintainability or\n consistency.
" + } + }, + "detectorId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the detector that detected the finding in your code. A detector is a\n defined rule based on industry standards and AWS best practices.
" + } + }, + "detectorName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the detector that identified the security vulnerability in your code.
" + } + }, + "ruleId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the rule that generated the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a finding that was detected in your code.
" + } + }, + "com.amazonaws.codegurusecurity#FindingIdentifier": { + "type": "structure", + "members": { + "scanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the scan that generated the finding.
", + "smithy.api#required": {} + } + }, + "findingId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for a finding.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains information about a finding and the scan that generated it.
" + } + }, + "com.amazonaws.codegurusecurity#FindingIdentifiers": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#FindingIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity": { + "type": "structure", + "members": { + "info": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The finding is related to quality or readability improvements and not considered\n actionable.
" + } + }, + "low": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The severity of the finding is low and does require action on its own.
" + } + }, + "medium": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The severity of the finding is medium and should be addressed as a mid-term priority.
" + } + }, + "high": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The severity of the finding is high and should be addressed as a near-term priority.
" + } + }, + "critical": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The severity of the finding is critical and should be addressed immediately.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The severity of the issue in the code that generated a finding.
" + } + }, + "com.amazonaws.codegurusecurity#Findings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#Finding" + } + }, + "com.amazonaws.codegurusecurity#FindingsMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#AccountFindingsMetric" + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to get account level configuration.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/accountConfiguration/get" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetAccountConfigurationResponse": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "An EncryptionConfig object that contains the KMS key ARN to use for\n encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify\n your own key, call UpdateAccountConfiguration.
Returns a list of all findings generated by a particular scan.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/findings/{scanName}" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findings" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetFindingsRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The name of the scan you want to retrieve findings from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.
The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.
The status of the findings you want to get. Pass either Open,\n Closed, or All.
A list of findings generated by the specified scan.
" + } + }, + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token. You can use this in future calls to GetFindings to continue listing\n results after the current page.
Returns top level metrics about an account from a specified date, including number of open\n findings, the categories with most findings, the scans with most open findings, and scans with\n most open critical findings.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/metrics/summary" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetMetricsSummaryRequest": { + "type": "structure", + "members": { + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The date you want to retrieve summary metrics from, rounded to the nearest day. The date\n must be within the past two years since metrics data is only stored for two years. If a date\n outside of this range is passed, the response will be empty.
", + "smithy.api#httpQuery": "date", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#GetMetricsSummaryResponse": { + "type": "structure", + "members": { + "metricsSummary": { + "target": "com.amazonaws.codegurusecurity#MetricsSummary", + "traits": { + "smithy.api#documentation": "The summary metrics from the specified date.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#GetScan": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#GetScanRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#GetScanResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns details about a scan, including whether or not a scan has completed.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/scans/{scanName}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#GetScanRequest": { + "type": "structure", + "members": { + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The name of the scan you want to view details about.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "UUID that identifies the individual scan run you want to view details about. You retrieve\n this when you call the CreateScan operation. Defaults to the latest scan run if missing.
The name of the scan.
", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "UUID that identifies the individual scan run.
", + "smithy.api#required": {} + } + }, + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "The current state of the scan. Pass either InProgress,\n Successful, or Failed.
The time the scan was created.
", + "smithy.api#required": {} + } + }, + "analysisType": { + "target": "com.amazonaws.codegurusecurity#AnalysisType", + "traits": { + "smithy.api#documentation": "The type of analysis CodeGuru Security performed in the scan, either\n Security or All. The Security type only generates\n findings related to security. The All type generates both security findings and\n quality findings.
The time when the scan was last updated. Only available for STANDARD scan types.
The number of times a scan has been re-run on a revised resource.
" + } + }, + "scanNameArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "The ARN for the scan name.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#HeaderKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codegurusecurity#HeaderValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.codegurusecurity#InternalServerException": { + "type": "structure", + "members": { + "error": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The internal error encountered by the server.
" + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The server encountered an internal error and is unable to complete the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.codegurusecurity#KmsKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:kms:[\\S]+:[\\d]{12}:key\\/(([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|(mrk-[0-9a-zA-Z]{32}))$" + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetricsRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#ListFindingsMetricsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns metrics about all findings in an account within a specified time range.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/metrics/findings" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "findingsMetrics" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetricsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the\n value of this parameter to null for the first request. For subsequent calls, use the nextToken\n value returned from the previous request to continue listing results after the first\n page.
The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.
The start date of the interval which you want to retrieve metrics from.
", + "smithy.api#httpQuery": "startDate", + "smithy.api#required": {} + } + }, + "endDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The end date of the interval which you want to retrieve metrics from.
", + "smithy.api#httpQuery": "endDate", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#ListFindingsMetricsResponse": { + "type": "structure", + "members": { + "findingsMetrics": { + "target": "com.amazonaws.codegurusecurity#FindingsMetricList", + "traits": { + "smithy.api#documentation": "A list of AccountFindingsMetric objects retrieved from the specified time interval.
A pagination token. You can use this in future calls to ListFindingMetrics to continue\n listing results after the current page.
Returns a list of all the scans in an account.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/scans" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "summaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListScansRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.codegurusecurity#NextToken", + "traits": { + "smithy.api#documentation": "A token to use for paginating results that are returned in the response. Set the value of\n this parameter to null for the first request. For subsequent calls, use the nextToken value\n returned from the previous request to continue listing results after the first page.
The maximum number of results to return in the response. Use this parameter when\n paginating results. If additional results exist beyond the number you specify, the nextToken\n element is returned in the response. Use nextToken in a subsequent request to retrieve\n additional results.
A list of ScanSummary objects with information about all scans in an account.
A pagination token. You can use this in future calls to ListScans to continue listing\n results after the current page.
Returns a list of all tags associated with a scan.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceArn}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.codegurusecurity#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:
\nA tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.
The date from which the metrics summary information was retrieved.
" + } + }, + "openFindings": { + "target": "com.amazonaws.codegurusecurity#FindingMetricsValuePerSeverity", + "traits": { + "smithy.api#documentation": "The number of open findings of each severity in an account.
" + } + }, + "categoriesWithMostFindings": { + "target": "com.amazonaws.codegurusecurity#CategoriesWithMostFindings", + "traits": { + "smithy.api#documentation": "A list of CategoryWithFindingNum objects for the top 5 finding categories\n with the most open findings in an account.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open critical findings in an account.
A list of ScanNameWithFindingNum objects for the top 3 scans with the most\n number of open findings in an account.
Information about summary metrics in an account.
" + } + }, + "com.amazonaws.codegurusecurity#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S]+$" + } + }, + "com.amazonaws.codegurusecurity#Recommendation": { + "type": "structure", + "members": { + "text": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The recommended course of action to remediate the finding.
" + } + }, + "url": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The URL address to the recommendation for remediating the finding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the recommended course of action to remediate a finding.
" + } + }, + "com.amazonaws.codegurusecurity#ReferenceUrls": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#RelatedVulnerabilities": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.codegurusecurity#Remediation": { + "type": "structure", + "members": { + "recommendation": { + "target": "com.amazonaws.codegurusecurity#Recommendation", + "traits": { + "smithy.api#documentation": "An object that contains information about the recommended course of action to remediate a finding.
" + } + }, + "suggestedFixes": { + "target": "com.amazonaws.codegurusecurity#SuggestedFixes", + "traits": { + "smithy.api#documentation": "A list of SuggestedFix objects. Each object contains information about a suggested code\n fix to remediate the finding.
Information about how to remediate a finding.
" + } + }, + "com.amazonaws.codegurusecurity#RequestHeaderMap": { + "type": "map", + "key": { + "target": "com.amazonaws.codegurusecurity#HeaderKey" + }, + "value": { + "target": "com.amazonaws.codegurusecurity#HeaderValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codegurusecurity#Resource": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the resource.
" + } + }, + "subResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for a section of the resource, such as an AWS Lambda layer.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that\n contains a finding.
" + } + }, + "com.amazonaws.codegurusecurity#ResourceId": { + "type": "union", + "members": { + "codeArtifactId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "The identifier for the code file uploaded to the resource where a finding was detected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The identifier for a resource object that contains resources where a finding was detected.
" + } + }, + "com.amazonaws.codegurusecurity#ResourceNotFoundException": { + "type": "structure", + "members": { + "errorCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
", + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the resource that was not found.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The type of resource that was not found.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The resource specified in the request was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.codegurusecurity#S3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.codegurusecurity#ScanName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 140 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_$:.]*$" + } + }, + "com.amazonaws.codegurusecurity#ScanNameArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^arn:aws:codeguru-security:[\\S]+:[\\d]{12}:scans\\/[a-zA-Z0-9-_$:.]*$" + } + }, + "com.amazonaws.codegurusecurity#ScanNameWithFindingNum": { + "type": "structure", + "members": { + "scanName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the scan.
" + } + }, + "findingNumber": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of open findings generated by a scan.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a scan with open findings.
" + } + }, + "com.amazonaws.codegurusecurity#ScanState": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Successful" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } + } + } + }, + "com.amazonaws.codegurusecurity#ScanSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanSummary" + } + }, + "com.amazonaws.codegurusecurity#ScanSummary": { + "type": "structure", + "members": { + "scanState": { + "target": "com.amazonaws.codegurusecurity#ScanState", + "traits": { + "smithy.api#documentation": "The state of the scan. A scan can be In Progress, \n Complete, or Failed.
The time when the scan was created.
", + "smithy.api#required": {} + } + }, + "updatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time the scan was last updated. A scan is updated when it is re-run.
" + } + }, + "scanName": { + "target": "com.amazonaws.codegurusecurity#ScanName", + "traits": { + "smithy.api#documentation": "The name of the scan.
", + "smithy.api#required": {} + } + }, + "runId": { + "target": "com.amazonaws.codegurusecurity#Uuid", + "traits": { + "smithy.api#documentation": "The identifier for the scan run.
", + "smithy.api#required": {} + } + }, + "scanNameArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "The ARN for the scan name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a scan.
" + } + }, + "com.amazonaws.codegurusecurity#ScanType": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "EXPRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Express" + } + } + } + }, + "com.amazonaws.codegurusecurity#ScansWithMostOpenCriticalFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanNameWithFindingNum" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.codegurusecurity#ScansWithMostOpenFindings": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ScanNameWithFindingNum" + }, + "traits": { + "smithy.api#length": { + "max": 3 + } + } + }, + "com.amazonaws.codegurusecurity#Severity": { + "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" + } + }, + "INFO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Info" + } + } + } + }, + "com.amazonaws.codegurusecurity#Status": { + "type": "enum", + "members": { + "CLOSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Closed" + } + }, + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Open" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + } + } + }, + "com.amazonaws.codegurusecurity#SuggestedFix": { + "type": "structure", + "members": { + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "A description of the suggested code fix and why it is being suggested.
" + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The suggested code to add to your file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the suggested code fix to remediate a finding.
" + } + }, + "com.amazonaws.codegurusecurity#SuggestedFixes": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#SuggestedFix" + } + }, + "com.amazonaws.codegurusecurity#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.codegurusecurity#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.codegurusecurity#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.codegurusecurity#TagKey" + }, + "value": { + "target": "com.amazonaws.codegurusecurity#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.codegurusecurity#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to add one or more tags to an existing scan.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceArn}", + "code": 204 + } + } + }, + "com.amazonaws.codegurusecurity#TagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.
An array of key-value pairs used to tag an existing scan. A tag is a custom attribute\n label with two parts:
\nA tag key. For example, CostCenter, Environment, or\n Secret. Tag keys are case sensitive.
An optional tag value field. For example, 111122223333,\n Production, or a team name. Omitting the tag value is the same as using an\n empty string. Tag values are case sensitive.
The identifier for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the originating service.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the originating quota.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.codegurusecurity#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#ConflictException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to remove one or more tags from an existing scan.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{resourceArn}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.codegurusecurity#UntagResourceRequest": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.codegurusecurity#ScanNameArn", + "traits": { + "smithy.api#documentation": "The ARN of the ScanName object. You can retrieve this ARN by calling\n ListScans or GetScan.
A list of keys for each tag you want to remove from a scan.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.codegurusecurity#UpdateAccountConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.codegurusecurity#AccessDeniedException" + }, + { + "target": "com.amazonaws.codegurusecurity#InternalServerException" + }, + { + "target": "com.amazonaws.codegurusecurity#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.codegurusecurity#ThrottlingException" + }, + { + "target": "com.amazonaws.codegurusecurity#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Use to update account-level configuration with an encryption key.
", + "smithy.api#http": { + "code": 200, + "method": "PUT", + "uri": "/updateAccountConfiguration" + } + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfigurationRequest": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.codegurusecurity#UpdateAccountConfigurationResponse": { + "type": "structure", + "members": { + "encryptionConfig": { + "target": "com.amazonaws.codegurusecurity#EncryptionConfig", + "traits": { + "smithy.api#documentation": "An EncryptionConfig object that contains the KMS key ARN to use for\n encryption.
The identifier for the error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Description of the error.
", + "smithy.api#required": {} + } + }, + "reason": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason the request failed validation.
", + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The field that caused the error, if applicable.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the specified constraints.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the exception.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Describes the exception.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a validation exception.
" + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.codegurusecurity#ValidationExceptionField" + } + }, + "com.amazonaws.codegurusecurity#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + }, + "LAMBDA_CODE_SHA_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lambdaCodeShaMisMatch" + } + } + } + }, + "com.amazonaws.codegurusecurity#Vulnerability": { + "type": "structure", + "members": { + "referenceUrls": { + "target": "com.amazonaws.codegurusecurity#ReferenceUrls", + "traits": { + "smithy.api#documentation": "One or more URL addresses that contain details about a vulnerability.
" + } + }, + "relatedVulnerabilities": { + "target": "com.amazonaws.codegurusecurity#RelatedVulnerabilities", + "traits": { + "smithy.api#documentation": "One or more vulnerabilities that are related to the vulnerability being described.
" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The identifier for the vulnerability.
" + } + }, + "filePath": { + "target": "com.amazonaws.codegurusecurity#FilePath", + "traits": { + "smithy.api#documentation": "An object that describes the location of the detected security vulnerability in your\n code.
" + } + }, + "itemCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The number of times the vulnerability appears in your code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a security vulnerability that Amazon CodeGuru Security detected.
" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json b/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json index a810f37a710..d821a86b2c9 100644 --- a/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json +++ b/codegen/sdk-codegen/aws-models/comprehendmedical.2018-10-30.json @@ -1257,6 +1257,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DescribeEntitiesDetectionV2JobResponse": { @@ -1268,6 +1271,9 @@ "smithy.api#documentation": "An object that contains the properties associated with a detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DescribeICD10CMInferenceJob": { @@ -1306,6 +1312,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DescribeICD10CMInferenceJobResponse": { @@ -1317,6 +1326,9 @@ "smithy.api#documentation": "An object that contains the properties associated with a detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DescribePHIDetectionJob": { @@ -1355,6 +1367,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DescribePHIDetectionJobResponse": { @@ -1366,6 +1381,9 @@ "smithy.api#documentation": "An object that contains the properties associated with a detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DescribeRxNormInferenceJob": { @@ -1404,6 +1422,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DescribeRxNormInferenceJobResponse": { @@ -1415,6 +1436,9 @@ "smithy.api#documentation": "An object that contains the properties associated with a detection job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJob": { @@ -1453,6 +1477,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DescribeSNOMEDCTInferenceJobResponse": { @@ -1461,6 +1488,9 @@ "ComprehendMedicalAsyncJobProperties": { "target": "com.amazonaws.comprehendmedical#ComprehendMedicalAsyncJobProperties" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DetectEntities": { @@ -1508,6 +1538,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DetectEntitiesResponse": { @@ -1539,6 +1572,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DetectEntitiesV2": { @@ -1583,6 +1619,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DetectEntitiesV2Response": { @@ -1614,6 +1653,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#DetectPHI": { @@ -1658,6 +1700,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#DetectPHIResponse": { @@ -1683,6 +1728,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#Entity": { @@ -2347,6 +2395,12 @@ "traits": { "smithy.api#enumValue": "SYSTEM_ORGAN_SITE" } + }, + "QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUALITY" + } } } }, @@ -2475,6 +2529,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#InferICD10CMResponse": { @@ -2499,6 +2556,9 @@ "smithy.api#documentation": "The version of the model used to analyze the documents, in the format\n n.n.n You can use this\n information to track the model used for a particular batch of documents.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#InferRxNorm": { @@ -2543,6 +2603,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#InferRxNormResponse": { @@ -2567,6 +2630,9 @@ "smithy.api#documentation": "The version of the model used to analyze the documents, in the format\n n.n.n You can use this\n information to track the model used for a particular batch of documents.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#InferSNOMEDCT": { @@ -2611,6 +2677,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#InferSNOMEDCTResponse": { @@ -2647,6 +2716,9 @@ "smithy.api#documentation": "\n The number of characters in the input request documentation. \n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#InputDataConfig": { @@ -2847,6 +2919,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#ListEntitiesDetectionV2JobsResponse": { @@ -2864,6 +2939,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#ListICD10CMInferenceJobs": { @@ -2913,6 +2991,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#ListICD10CMInferenceJobsResponse": { @@ -2930,6 +3011,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#ListPHIDetectionJobs": { @@ -2979,6 +3063,9 @@ "smithy.api#documentation": "The maximum number of results to return in each page. The default is 100.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#ListPHIDetectionJobsResponse": { @@ -2996,6 +3083,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#ListRxNormInferenceJobs": { @@ -3045,6 +3135,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#ListRxNormInferenceJobsResponse": { @@ -3062,6 +3155,9 @@ "smithy.api#documentation": "Identifies the next page of results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobs": { @@ -3108,6 +3204,9 @@ "smithy.api#documentation": "\n The maximum number of results to return in each page. The default is 100.\n
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#ListSNOMEDCTInferenceJobsResponse": { @@ -3125,6 +3224,9 @@ "smithy.api#documentation": "\n Identifies the next page of results to return.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#ManifestFilePath": { @@ -3300,6 +3402,18 @@ "traits": { "smithy.api#enumValue": "AMOUNT" } + }, + "USAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USAGE" + } + }, + "QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUALITY" + } } } }, @@ -3593,6 +3707,12 @@ "traits": { "smithy.api#enumValue": "NEGATION" } + }, + "PAST_HISTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAST_HISTORY" + } } } }, @@ -3959,6 +4079,12 @@ "traits": { "smithy.api#enumValue": "SYSTEM_ORGAN_SITE" } + }, + "TEST_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEST_UNIT" + } } } }, @@ -4136,6 +4262,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#StartEntitiesDetectionV2JobResponse": { @@ -4147,6 +4276,9 @@ "smithy.api#documentation": "The identifier generated for the job. To get the status of a job, use this identifier with\n the DescribeEntitiesDetectionV2Job operation.
The identifier generated for the job. To get the status of a job, use this identifier with\n the StartICD10CMInferenceJob operation.
The identifier generated for the job. To get the status of a job, use this identifier with\n the DescribePHIDetectionJob operation.
The identifier of the job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJob": { @@ -4490,6 +4640,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#StartSNOMEDCTInferenceJobResponse": { @@ -4501,6 +4654,9 @@ "smithy.api#documentation": "\n The identifier generated for the job. To get the status of a job, use this identifier with the StartSNOMEDCTInferenceJob operation.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#StopEntitiesDetectionV2Job": { @@ -4536,6 +4692,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#StopEntitiesDetectionV2JobResponse": { @@ -4547,6 +4706,9 @@ "smithy.api#documentation": "The identifier of the medical entities detection job that was stopped.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#StopICD10CMInferenceJob": { @@ -4582,6 +4744,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#StopICD10CMInferenceJobResponse": { @@ -4593,6 +4758,9 @@ "smithy.api#documentation": "The identifier generated for the job. To get the status of job, use this identifier with\n the DescribeICD10CMInferenceJob operation.
The identifier of the PHI detection job that was stopped.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#StopRxNormInferenceJob": { @@ -4674,6 +4848,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.comprehendmedical#StopRxNormInferenceJobResponse": { @@ -4685,6 +4862,9 @@ "smithy.api#documentation": "The identifier generated for the job. To get the status of job, use this identifier with\n the DescribeRxNormInferenceJob operation.
\n The identifier generated for the job. To get the status of job, use this identifier with the DescribeSNOMEDCTInferenceJob operation.\n
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.comprehendmedical#String": { diff --git a/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json b/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json index f96f7b6f754..bdcaa60b956 100644 --- a/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json +++ b/codegen/sdk-codegen/aws-models/config-service.2014-11-12.json @@ -13333,6 +13333,132 @@ "traits": { "smithy.api#enumValue": "AWS::SageMaker::Image" } + }, + "ECSTaskSet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::ECS::TaskSet" + } + }, + "CassandraKeyspace": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Cassandra::Keyspace" + } + }, + "SignerSigningProfile": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Signer::SigningProfile" + } + }, + "AmplifyApp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Amplify::App" + } + }, + "AppMeshVirtualNode": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::AppMesh::VirtualNode" + } + }, + "AppMeshVirtualService": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::AppMesh::VirtualService" + } + }, + "AppRunnerVpcConnector": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::AppRunner::VpcConnector" + } + }, + "AppStreamApplication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::AppStream::Application" + } + }, + "CodeArtifactRepository": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::CodeArtifact::Repository" + } + }, + "EC2PrefixList": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::EC2::PrefixList" + } + }, + "EC2SpotFleet": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::EC2::SpotFleet" + } + }, + "EvidentlyProject": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Evidently::Project" + } + }, + "ForecastDataset": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Forecast::Dataset" + } + }, + "IAMSAMLProvider": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IAM::SAMLProvider" + } + }, + "IAMServerCertificate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::IAM::ServerCertificate" + } + }, + "PinpointCampaign": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Pinpoint::Campaign" + } + }, + "PinpointInAppTemplate": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Pinpoint::InAppTemplate" + } + }, + "SageMakerDomain": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::SageMaker::Domain" + } + }, + "TransferAgreement": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Transfer::Agreement" + } + }, + "TransferConnector": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::Transfer::Connector" + } + }, + "KinesisFirehoseDeliveryStream": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS::KinesisFirehose::DeliveryStream" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json index 326e3c7845a..bcecafbbf24 100644 --- a/codegen/sdk-codegen/aws-models/connect.2017-08-08.json +++ b/codegen/sdk-codegen/aws-models/connect.2017-08-08.json @@ -961,9 +961,18 @@ { "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" }, + { + "target": "com.amazonaws.connect#SearchHoursOfOperations" + }, + { + "target": "com.amazonaws.connect#SearchPrompts" + }, { "target": "com.amazonaws.connect#SearchQueues" }, + { + "target": "com.amazonaws.connect#SearchQuickConnects" + }, { "target": "com.amazonaws.connect#SearchRoutingProfiles" }, @@ -3282,7 +3291,7 @@ "InitiationTimestamp": { "target": "com.amazonaws.connect#Timestamp", "traits": { - "smithy.api#documentation": "The date and time this contact was initiated, in UTC time. For INBOUND, this is\n when the contact arrived. For OUTBOUND, this is when the agent began dialing. For\n CALLBACK, this is when the callback contact was created. For TRANSFER\n and QUEUE_TRANSFER, this is when the transfer was initiated. For API,\n this is when the request arrived.
The date and time this contact was initiated, in UTC time. For INBOUND, this is\n when the contact arrived. For OUTBOUND, this is when the agent began dialing. For\n CALLBACK, this is when the callback contact was created. For TRANSFER\n and QUEUE_TRANSFER, this is when the transfer was initiated. For API,\n this is when the request arrived. For EXTERNAL_OUTBOUND, this is when the agent started \n dialing the external participant. For MONITOR, this is when the supervisor started \n listening to a contact.
Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 35 days, in 24-hour\n intervals.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator's Guide.
This API is not available in the Amazon Web Services GovCloud (US) Regions.
", + "smithy.api#documentation": "Gets metric data from the specified Amazon Connect instance.
\n\n GetMetricDataV2 offers more features than GetMetricData, the previous\n version of this API. It has new metrics, offers filtering at a metric level, and offers the\n ability to filter and group data by channels, queues, routing profiles, agents, and agent\n hierarchy levels. It can retrieve historical data for the last 35 days, in 24-hour\n intervals.
For a description of the historical metrics that are supported by\n GetMetricDataV2 and GetMetricData, see Historical metrics\n definitions in the Amazon Connect Administrator's Guide.
A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#HoursOfOperationSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, timezone, and resourceID.
The search criteria to be used to return hours of operations.
" + } + }, + "com.amazonaws.connect#HoursOfOperationSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, "com.amazonaws.connect#HoursOfOperationSummary": { "type": "structure", "members": { @@ -13330,6 +13388,12 @@ "traits": { "smithy.api#documentation": "Whether outbound calls are enabled.
" } + }, + "InstanceAccessUrl": { + "target": "com.amazonaws.connect#Url", + "traits": { + "smithy.api#documentation": "This URL allows contact center users to access Amazon Connect admin website.
" + } } }, "traits": { @@ -13579,6 +13643,12 @@ "traits": { "smithy.api#enumValue": "CONTACT_EVALUATIONS" } + }, + "SCREEN_RECORDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCREEN_RECORDINGS" + } } } }, @@ -13638,6 +13708,12 @@ "traits": { "smithy.api#documentation": "Whether outbound calls are enabled.
" } + }, + "InstanceAccessUrl": { + "target": "com.amazonaws.connect#Url", + "traits": { + "smithy.api#documentation": "This URL allows contact center users to access Amazon Connect admin website.
" + } } }, "traits": { @@ -19963,7 +20039,7 @@ "Description": { "target": "com.amazonaws.connect#PromptDescription", "traits": { - "smithy.api#documentation": "A description for the prompt.
" + "smithy.api#documentation": "The description of the prompt.
" } }, "Tags": { @@ -19995,6 +20071,12 @@ } } }, + "com.amazonaws.connect#PromptList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Prompt" + } + }, "com.amazonaws.connect#PromptName": { "type": "string", "traits": { @@ -20013,6 +20095,49 @@ } } }, + "com.amazonaws.connect#PromptSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#PromptSearchCriteria" + } + }, + "com.amazonaws.connect#PromptSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#PromptSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#PromptSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, and resourceID.
The search criteria to be used to return prompts.
" + } + }, + "com.amazonaws.connect#PromptSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, "com.amazonaws.connect#PromptSummary": { "type": "structure", "members": { @@ -20392,7 +20517,10 @@ } }, "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, and resourceID.
A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#QuickConnectSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, and resourceID.
The search criteria to be used to return quick connects.
" + } + }, + "com.amazonaws.connect#QuickConnectSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "com.amazonaws.connect#QuickConnectSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QuickConnect" + } + }, "com.amazonaws.connect#QuickConnectSummary": { "type": "structure", "members": { @@ -21243,7 +21420,7 @@ } ], "traits": { - "smithy.api#documentation": "When a contact is being recorded, and the recording has been suspended using\n SuspendContactRecording, this API resumes recording the call.
\nOnly voice recordings are supported at this time.
", + "smithy.api#documentation": "When a contact is being recorded, and the recording has been suspended using \n SuspendContactRecording, this API resumes recording the call or screen.
\nVoice and screen recordings are supported.
", "smithy.api#http": { "method": "POST", "uri": "/contact/resume-recording", @@ -21553,7 +21730,10 @@ } }, "StringCondition": { - "target": "com.amazonaws.connect#StringCondition" + "target": "com.amazonaws.connect#StringCondition", + "traits": { + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, and resourceID.
Searches the hours of operation in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-hours-of-operations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "HoursOfOperations", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchHoursOfOperationsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#HoursOfOperationSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#HoursOfOperationSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return hours of operations.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchHoursOfOperationsResponse": { + "type": "structure", + "members": { + "HoursOfOperations": { + "target": "com.amazonaws.connect#HoursOfOperationList", + "traits": { + "smithy.api#documentation": "Information about the hours of operations.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of hours of operations which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.connect#SearchPrompts": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchPromptsRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchPromptsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Searches prompts in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-prompts", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Prompts", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchPromptsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#PromptSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#PromptSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return prompts.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchPromptsResponse": { + "type": "structure", + "members": { + "Prompts": { + "target": "com.amazonaws.connect#PromptList", + "traits": { + "smithy.api#documentation": "Information about the prompts.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of quick connects which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchQueues": { "type": "operation", "input": { @@ -22123,6 +22515,112 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#SearchQuickConnects": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchQuickConnectsRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchQuickConnectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Searches quick connects in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-quick-connects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "QuickConnects", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchQuickConnectsRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#QuickConnectSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#QuickConnectSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return quick connects.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#SearchQuickConnectsResponse": { + "type": "structure", + "members": { + "QuickConnects": { + "target": "com.amazonaws.connect#QuickConnectSearchSummaryList", + "traits": { + "smithy.api#documentation": "Information about the quick connects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of quick connects which matched your search query.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#SearchRoutingProfiles": { "type": "operation", "input": { @@ -23944,7 +24442,7 @@ } }, "traits": { - "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported value for FieldName: name\n
A leaf node condition which can be used to specify a string condition.
" } }, "com.amazonaws.connect#StringReference": { @@ -24103,7 +24601,7 @@ } ], "traits": { - "smithy.api#documentation": "When a contact is being recorded, this API suspends recording the call. For example, you\n might suspend the call recording while collecting sensitive information, such as a credit card\n number. Then use ResumeContactRecording to restart recording.
\nThe period of time that the recording is suspended is filled with silence in the final\n recording.
\nOnly voice recordings are supported at this time.
", + "smithy.api#documentation": "When a contact is being recorded, this API suspends recording the call or screen. For \n example, you might suspend the call or screen recording while collecting sensitive \n information, such as a credit card number. Then use ResumeContactRecording to restart recording.
\nThe period of time that the recording is suspended is filled with silence in the final recording.
\nVoice and screen recordings are supported.
", "smithy.api#http": { "method": "POST", "uri": "/contact/suspend-recording", @@ -28712,7 +29210,7 @@ "StringCondition": { "target": "com.amazonaws.connect#StringCondition", "traits": { - "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
" + "smithy.api#documentation": "A leaf node condition which can be used to specify a string condition.
\nThe currently supported values for FieldName are name, \n description, and resourceID.
Creates an event stream, which is a subscription to real-time events, such as when profiles are created and \n updated through Amazon Connect Customer Profiles.
\nEach event stream can be associated with only one Kinesis Data Stream destination in the same region and \n Amazon Web Services account as the customer profiles domain
", + "smithy.api#http": { + "method": "POST", + "uri": "/domains/{DomainName}/event-streams/{EventStreamName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#CreateEventStreamRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "The StreamARN of the destination to deliver profile events to. For example, \n arn:aws:kinesis:region:account-id:stream/stream-name
", + "smithy.api#required": {} + } + }, + "EventStreamName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The name of the event stream.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#CreateEventStreamResponse": { + "type": "structure", + "members": { + "EventStreamArn": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "A unique identifier for the event stream.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#CreateIntegrationWorkflow": { "type": "operation", "input": { @@ -1289,6 +1381,9 @@ { "target": "com.amazonaws.customerprofiles#CreateDomain" }, + { + "target": "com.amazonaws.customerprofiles#CreateEventStream" + }, { "target": "com.amazonaws.customerprofiles#CreateIntegrationWorkflow" }, @@ -1301,6 +1396,9 @@ { "target": "com.amazonaws.customerprofiles#DeleteDomain" }, + { + "target": "com.amazonaws.customerprofiles#DeleteEventStream" + }, { "target": "com.amazonaws.customerprofiles#DeleteIntegration" }, @@ -1331,6 +1429,9 @@ { "target": "com.amazonaws.customerprofiles#GetDomain" }, + { + "target": "com.amazonaws.customerprofiles#GetEventStream" + }, { "target": "com.amazonaws.customerprofiles#GetIdentityResolutionJob" }, @@ -1364,6 +1465,9 @@ { "target": "com.amazonaws.customerprofiles#ListDomains" }, + { + "target": "com.amazonaws.customerprofiles#ListEventStreams" + }, { "target": "com.amazonaws.customerprofiles#ListIdentityResolutionJobs" }, @@ -2373,6 +2477,72 @@ "smithy.api#output": {} } }, + "com.amazonaws.customerprofiles#DeleteEventStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#DeleteEventStreamRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#DeleteEventStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Disables and deletes the specified event stream.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/domains/{DomainName}/event-streams/{EventStreamName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.customerprofiles#DeleteEventStreamRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EventStreamName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The name of the event stream
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#DeleteEventStreamResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#DeleteIntegration": { "type": "operation", "input": { @@ -2834,6 +3004,34 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.customerprofiles#DestinationSummary": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "The StreamARN of the destination to deliver profile events to. For example, \n arn:aws:kinesis:region:account-id:stream/stream-name.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#EventStreamDestinationStatus", + "traits": { + "smithy.api#documentation": "The status of enabling the Kinesis stream as a destination for export.
", + "smithy.api#required": {} + } + }, + "UnhealthySince": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the status last changed to UNHEALHY.
Summary information about the Kinesis data stream
" + } + }, "com.amazonaws.customerprofiles#DomainList": { "type": "list", "member": { @@ -2888,6 +3086,134 @@ } } }, + "com.amazonaws.customerprofiles#EventStreamDestinationDetails": { + "type": "structure", + "members": { + "Uri": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "The StreamARN of the destination to deliver profile events to. For example, \n arn:aws:kinesis:region:account-id:stream/stream-name.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.customerprofiles#EventStreamDestinationStatus", + "traits": { + "smithy.api#documentation": "The status of enabling the Kinesis stream as a destination for export.
", + "smithy.api#required": {} + } + }, + "UnhealthySince": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the status last changed to UNHEALHY.
The human-readable string that corresponds to the error or success while enabling the streaming destination.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of the destination being used for the EventStream.
" + } + }, + "com.amazonaws.customerprofiles#EventStreamDestinationStatus": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } + } + }, + "com.amazonaws.customerprofiles#EventStreamState": { + "type": "enum", + "members": { + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + } + } + }, + "com.amazonaws.customerprofiles#EventStreamSummary": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#required": {} + } + }, + "EventStreamName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The name of the event stream.
", + "smithy.api#required": {} + } + }, + "EventStreamArn": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "A unique identifier for the event stream.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.customerprofiles#EventStreamState", + "traits": { + "smithy.api#documentation": "The operational state of destination stream for export.
", + "smithy.api#required": {} + } + }, + "StoppedSince": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the State changed to STOPPED.
Summary information about the Kinesis data stream.
" + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An instance of EventStream in a list of EventStreams.
" + } + }, + "com.amazonaws.customerprofiles#EventStreamSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.customerprofiles#EventStreamSummary" + } + }, "com.amazonaws.customerprofiles#ExportingConfig": { "type": "structure", "members": { @@ -3654,6 +3980,119 @@ "smithy.api#output": {} } }, + "com.amazonaws.customerprofiles#GetEventStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#GetEventStreamRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#GetEventStreamResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the specified event stream in a specific domain.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/event-streams/{EventStreamName}", + "code": 200 + } + } + }, + "com.amazonaws.customerprofiles#GetEventStreamRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EventStreamName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The name of the event stream provided during create operations.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#GetEventStreamResponse": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#required": {} + } + }, + "EventStreamArn": { + "target": "com.amazonaws.customerprofiles#string1To255", + "traits": { + "smithy.api#documentation": "A unique identifier for the event stream.
", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export was created.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.customerprofiles#EventStreamState", + "traits": { + "smithy.api#documentation": "The operational state of destination stream for export.
", + "smithy.api#required": {} + } + }, + "StoppedSince": { + "target": "com.amazonaws.customerprofiles#timestamp", + "traits": { + "smithy.api#documentation": "The timestamp when the State changed to STOPPED.
Details regarding the Kinesis stream.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.customerprofiles#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#GetIdentityResolutionJob": { "type": "operation", "input": { @@ -5201,6 +5640,96 @@ "smithy.api#output": {} } }, + "com.amazonaws.customerprofiles#ListEventStreams": { + "type": "operation", + "input": { + "target": "com.amazonaws.customerprofiles#ListEventStreamsRequest" + }, + "output": { + "target": "com.amazonaws.customerprofiles#ListEventStreamsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.customerprofiles#AccessDeniedException" + }, + { + "target": "com.amazonaws.customerprofiles#BadRequestException" + }, + { + "target": "com.amazonaws.customerprofiles#InternalServerException" + }, + { + "target": "com.amazonaws.customerprofiles#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.customerprofiles#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all the event streams in a specific domain.
", + "smithy.api#http": { + "method": "GET", + "uri": "/domains/{DomainName}/event-streams", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.customerprofiles#ListEventStreamsRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.customerprofiles#name", + "traits": { + "smithy.api#documentation": "The unique name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "Identifies the next page of results to return.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.customerprofiles#maxSize100", + "traits": { + "smithy.api#documentation": "The maximum number of objects returned per page.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.customerprofiles#ListEventStreamsResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.customerprofiles#EventStreamSummaryList", + "traits": { + "smithy.api#documentation": "Contains summary information about an EventStream.
" + } + }, + "NextToken": { + "target": "com.amazonaws.customerprofiles#token", + "traits": { + "smithy.api#documentation": "Identifies the next page of results to return.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.customerprofiles#ListIdentityResolutionJobs": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json b/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json index c27846f13fb..ef827489798 100644 --- a/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json +++ b/codegen/sdk-codegen/aws-models/direct-connect.2012-10-25.json @@ -1210,7 +1210,7 @@ "jumboFrameCapable": { "target": "com.amazonaws.directconnect#JumboFrameCapable", "traits": { - "smithy.api#documentation": "Indicates whether jumbo frames (9001 MTU) are supported.
" + "smithy.api#documentation": "Indicates whether jumbo frames are supported.
" } }, "awsDeviceV2": { @@ -3924,7 +3924,7 @@ "jumboFrameCapable": { "target": "com.amazonaws.directconnect#JumboFrameCapable", "traits": { - "smithy.api#documentation": "Indicates whether jumbo frames (9001 MTU) are supported.
" + "smithy.api#documentation": "Indicates whether jumbo frames are supported.
" } }, "awsDeviceV2": { @@ -4128,7 +4128,7 @@ "jumboFrameCapable": { "target": "com.amazonaws.directconnect#JumboFrameCapable", "traits": { - "smithy.api#documentation": "Indicates whether jumbo frames (9001 MTU) are supported.
" + "smithy.api#documentation": "Indicates whether jumbo frames are supported.
" } }, "hasLogicalRedundancy": { @@ -6879,7 +6879,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified attributes of the specified virtual private interface.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual q\n interface supports jumbo frames, call DescribeVirtualInterfaces.
" + "smithy.api#documentation": "Updates the specified attributes of the specified virtual private interface.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" } }, "com.amazonaws.directconnect#UpdateVirtualInterfaceAttributesRequest": { @@ -7077,7 +7077,7 @@ "jumboFrameCapable": { "target": "com.amazonaws.directconnect#JumboFrameCapable", "traits": { - "smithy.api#documentation": "Indicates whether jumbo frames (9001 MTU) are supported.
" + "smithy.api#documentation": "Indicates whether jumbo frames are supported.
" } }, "virtualGatewayId": { diff --git a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json index af9380ee205..bab16cabee2 100644 --- a/codegen/sdk-codegen/aws-models/drs.2020-02-26.json +++ b/codegen/sdk-codegen/aws-models/drs.2020-02-26.json @@ -86,6 +86,94 @@ } } }, + "com.amazonaws.drs#AssociateSourceNetworkStack": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#AssociateSourceNetworkStackRequest" + }, + "output": { + "target": "com.amazonaws.drs#AssociateSourceNetworkStackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "cloudformation:DescribeStacks", + "cloudformation:DescribeStackResource", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:ModifyLaunchTemplate", + "ec2:CreateLaunchTemplateVersion", + "drs:GetLaunchConfiguration" + ], + "smithy.api#documentation": "Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.
", + "smithy.api#http": { + "uri": "/AssociateSourceNetworkStack", + "method": "POST", + "code": 202 + } + } + }, + "com.amazonaws.drs#AssociateSourceNetworkStackRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "The Source Network ID to associate with CloudFormation template.
", + "smithy.api#required": {} + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "CloudFormation template to associate with a Source Network.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#AssociateSourceNetworkStackResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "The Source Network association Job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#AwsAvailabilityZone": { "type": "string", "traits": { @@ -136,6 +224,17 @@ "smithy.api#documentation": "Information about a server's CPU.
" } }, + "com.amazonaws.drs#CfnStackName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z][-a-zA-Z0-9]*$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.drs#ConflictException": { "type": "structure", "members": { @@ -367,6 +466,12 @@ "traits": { "smithy.api#documentation": "Licensing.
" } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" + } } } }, @@ -526,6 +631,99 @@ } } }, + "com.amazonaws.drs#CreateSourceNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#CreateSourceNetworkRequest" + }, + "output": { + "target": "com.amazonaws.drs#CreateSourceNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeVpcs", + "ec2:DescribeInstances" + ], + "smithy.api#documentation": "Create a new Source Network resource for a provided VPC ID.
", + "smithy.api#http": { + "uri": "/CreateSourceNetwork", + "method": "POST", + "code": 201 + } + } + }, + "com.amazonaws.drs#CreateSourceNetworkRequest": { + "type": "structure", + "members": { + "vpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "Which VPC ID to protect.
", + "smithy.api#required": {} + } + }, + "originAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "Account containing the VPC to protect.
", + "smithy.api#required": {} + } + }, + "originRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "Region containing the VPC to protect.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A set of tags to be associated with the Source Network resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#CreateSourceNetworkResponse": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "ID of the created Source Network.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#DataReplicationError": { "type": "structure", "members": { @@ -1089,6 +1287,63 @@ "type": "structure", "members": {} }, + "com.amazonaws.drs#DeleteSourceNetwork": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DeleteSourceNetworkRequest" + }, + "output": { + "target": "com.amazonaws.drs#DeleteSourceNetworkResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Delete Source Network resource.
", + "smithy.api#http": { + "uri": "/DeleteSourceNetwork", + "method": "POST", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.drs#DeleteSourceNetworkRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "ID of the Source Network to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#DeleteSourceNetworkResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#DeleteSourceServer": { "type": "operation", "input": { @@ -1725,13 +1980,13 @@ } } }, - "com.amazonaws.drs#DescribeSourceServers": { + "com.amazonaws.drs#DescribeSourceNetworks": { "type": "operation", "input": { - "target": "com.amazonaws.drs#DescribeSourceServersRequest" + "target": "com.amazonaws.drs#DescribeSourceNetworksRequest" }, "output": { - "target": "com.amazonaws.drs#DescribeSourceServersResponse" + "target": "com.amazonaws.drs#DescribeSourceNetworksResponse" }, "errors": [ { @@ -1748,9 +2003,9 @@ } ], "traits": { - "smithy.api#documentation": "Lists all Source Servers or multiple Source Servers filtered by ID.
", + "smithy.api#documentation": "Lists all Source Networks or multiple Source Networks filtered by ID.
", "smithy.api#http": { - "uri": "/DescribeSourceServers", + "uri": "/DescribeSourceNetworks", "method": "POST", "code": 200 }, @@ -1763,117 +2018,240 @@ "smithy.api#readonly": {} } }, - "com.amazonaws.drs#DescribeSourceServersRequest": { + "com.amazonaws.drs#DescribeSourceNetworksRequest": { "type": "structure", "members": { "filters": { - "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", + "target": "com.amazonaws.drs#DescribeSourceNetworksRequestFilters", "traits": { - "smithy.api#documentation": "A set of filters by which to return Source Servers.
" + "smithy.api#documentation": "A set of filters by which to return Source Networks.
" } }, "maxResults": { "target": "com.amazonaws.drs#StrictlyPositiveInteger", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Maximum number of Source Servers to retrieve.
" + "smithy.api#documentation": "Maximum number of Source Networks to retrieve.
" } }, "nextToken": { "target": "com.amazonaws.drs#PaginationToken", "traits": { - "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + "smithy.api#documentation": "The token of the next Source Networks to retrieve.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.drs#DescribeSourceServersRequestFilters": { + "com.amazonaws.drs#DescribeSourceNetworksRequestFilters": { "type": "structure", "members": { - "sourceServerIDs": { - "target": "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs", + "sourceNetworkIDs": { + "target": "com.amazonaws.drs#DescribeSourceNetworksRequestFiltersIDs", "traits": { - "smithy.api#documentation": "An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
" + "smithy.api#documentation": "An array of Source Network IDs that should be returned. An empty array means all Source Networks.
" } }, - "hardwareId": { - "target": "com.amazonaws.drs#BoundedString", + "originAccountID": { + "target": "com.amazonaws.drs#AccountID", "traits": { - "smithy.api#documentation": "An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
" + "smithy.api#documentation": "Filter Source Networks by account ID containing the protected VPCs.
" } }, - "stagingAccountIDs": { - "target": "com.amazonaws.drs#AccountIDs", + "originRegion": { + "target": "com.amazonaws.drs#AwsRegion", "traits": { - "smithy.api#documentation": "An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
" + "smithy.api#documentation": "Filter Source Networks by the region containing the protected VPCs.
" } } }, "traits": { - "smithy.api#documentation": "A set of filters by which to return Source Servers.
" + "smithy.api#documentation": "A set of filters by which to return Source Networks.
" } }, - "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs": { + "com.amazonaws.drs#DescribeSourceNetworksRequestFiltersIDs": { "type": "list", "member": { - "target": "com.amazonaws.drs#SourceServerID" + "target": "com.amazonaws.drs#SourceNetworkID" }, "traits": { "smithy.api#length": { "min": 0, - "max": 200 + "max": 100 } } }, - "com.amazonaws.drs#DescribeSourceServersResponse": { + "com.amazonaws.drs#DescribeSourceNetworksResponse": { "type": "structure", "members": { "items": { - "target": "com.amazonaws.drs#SourceServersList", + "target": "com.amazonaws.drs#SourceNetworksList", "traits": { - "smithy.api#documentation": "An array of Source Servers.
" + "smithy.api#documentation": "An array of Source Networks.
" } }, "nextToken": { "target": "com.amazonaws.drs#PaginationToken", "traits": { - "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + "smithy.api#documentation": "The token of the next Source Networks to retrieve.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.drs#DisconnectRecoveryInstance": { + "com.amazonaws.drs#DescribeSourceServers": { "type": "operation", "input": { - "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" + "target": "com.amazonaws.drs#DescribeSourceServersRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.drs#DescribeSourceServersResponse" }, "errors": [ - { - "target": "com.amazonaws.drs#AccessDeniedException" - }, - { - "target": "com.amazonaws.drs#ConflictException" - }, { "target": "com.amazonaws.drs#InternalServerException" }, - { - "target": "com.amazonaws.drs#ResourceNotFoundException" - }, { "target": "com.amazonaws.drs#ThrottlingException" }, { "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" } ], "traits": { - "smithy.api#documentation": "Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
", + "smithy.api#documentation": "Lists all Source Servers or multiple Source Servers filtered by ID.
", "smithy.api#http": { - "uri": "/DisconnectRecoveryInstance", + "uri": "/DescribeSourceServers", + "method": "POST", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "items" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.drs#DescribeSourceServersRequest": { + "type": "structure", + "members": { + "filters": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFilters", + "traits": { + "smithy.api#documentation": "A set of filters by which to return Source Servers.
" + } + }, + "maxResults": { + "target": "com.amazonaws.drs#StrictlyPositiveInteger", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Maximum number of Source Servers to retrieve.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFilters": { + "type": "structure", + "members": { + "sourceServerIDs": { + "target": "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs", + "traits": { + "smithy.api#documentation": "An array of Source Servers IDs that should be returned. An empty array means all Source Servers.
" + } + }, + "hardwareId": { + "target": "com.amazonaws.drs#BoundedString", + "traits": { + "smithy.api#documentation": "An ID that describes the hardware of the Source Server. This is either an EC2 instance id, a VMware uuid or a mac address.
" + } + }, + "stagingAccountIDs": { + "target": "com.amazonaws.drs#AccountIDs", + "traits": { + "smithy.api#documentation": "An array of staging account IDs that extended source servers belong to. An empty array means all source servers will be shown.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of filters by which to return Source Servers.
" + } + }, + "com.amazonaws.drs#DescribeSourceServersRequestFiltersIDs": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceServerID" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.drs#DescribeSourceServersResponse": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.drs#SourceServersList", + "traits": { + "smithy.api#documentation": "An array of Source Servers.
" + } + }, + "nextToken": { + "target": "com.amazonaws.drs#PaginationToken", + "traits": { + "smithy.api#documentation": "The token of the next Source Server to retrieve.
" + } + } + } + }, + "com.amazonaws.drs#DisconnectRecoveryInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#DisconnectRecoveryInstanceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.drs#AccessDeniedException" + }, + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Disconnect a Recovery Instance from Elastic Disaster Recovery. Data replication is stopped immediately. All AWS resources created by Elastic Disaster Recovery for enabling the replication of the Recovery Instance will be terminated / deleted within 90 minutes. If the agent on the Recovery Instance has not been prevented from communicating with the Elastic Disaster Recovery service, then it will receive a command to uninstall itself (within approximately 10 minutes). The following properties of the Recovery Instance will be changed immediately: dataReplicationInfo.dataReplicationState will be set to DISCONNECTED; The totalStorageBytes property for each of dataReplicationInfo.replicatedDisks will be set to zero; dataReplicationInfo.lagDuration and dataReplicationInfo.lagDuration will be nullified.
", + "smithy.api#http": { + "uri": "/DisconnectRecoveryInstance", "method": "POST", "code": 200 } @@ -2088,6 +2466,9 @@ { "target": "com.amazonaws.drs#ReplicationConfigurationTemplateResource" }, + { + "target": "com.amazonaws.drs#SourceNetworkResource" + }, { "target": "com.amazonaws.drs#SourceServerResource" } @@ -3051,6 +3432,91 @@ } } }, + "com.amazonaws.drs#EventResourceData": { + "type": "union", + "members": { + "sourceNetworkData": { + "target": "com.amazonaws.drs#SourceNetworkData", + "traits": { + "smithy.api#documentation": "Source Network properties.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties of resource related to a job event.
" + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplateRequest" + }, + "output": { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "s3:GetBucketLocation", + "s3:PutObject", + "s3:GetObject" + ], + "smithy.api#documentation": "Export the Source Network CloudFormation template to an S3 bucket.
", + "smithy.api#http": { + "uri": "/ExportSourceNetworkCfnTemplate", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplateRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "The Source Network ID to export its CloudFormation template to an S3 bucket.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#ExportSourceNetworkCfnTemplateResponse": { + "type": "structure", + "members": { + "s3DestinationUrl": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "S3 bucket URL where the Source Network CloudFormation template was exported to.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#ExtensionStatus": { "type": "string", "traits": { @@ -3506,6 +3972,18 @@ { "value": "TARGET_ACCOUNT", "name": "TARGET_ACCOUNT" + }, + { + "value": "CREATE_NETWORK_RECOVERY", + "name": "CREATE_NETWORK_RECOVERY" + }, + { + "value": "UPDATE_NETWORK_RECOVERY", + "name": "UPDATE_NETWORK_RECOVERY" + }, + { + "value": "ASSOCIATE_NETWORK_RECOVERY", + "name": "ASSOCIATE_NETWORK_RECOVERY" } ] } @@ -3591,6 +4069,12 @@ "traits": { "smithy.api#documentation": "A list of tags associated with the Job.
" } + }, + "participatingResources": { + "target": "com.amazonaws.drs#ParticipatingResources", + "traits": { + "smithy.api#documentation": "A list of resources that the Job is acting upon.
" + } } }, "traits": { @@ -3704,6 +4188,46 @@ { "name": "JOB_END", "value": "JOB_END" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_START", + "value": "DEPLOY_NETWORK_CONFIGURATION_START" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_END", + "value": "DEPLOY_NETWORK_CONFIGURATION_END" + }, + { + "name": "DEPLOY_NETWORK_CONFIGURATION_FAILED", + "value": "DEPLOY_NETWORK_CONFIGURATION_FAILED" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_START", + "value": "UPDATE_NETWORK_CONFIGURATION_START" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_END", + "value": "UPDATE_NETWORK_CONFIGURATION_END" + }, + { + "name": "UPDATE_NETWORK_CONFIGURATION_FAILED", + "value": "UPDATE_NETWORK_CONFIGURATION_FAILED" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_START", + "value": "UPDATE_LAUNCH_TEMPLATE_START" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_END", + "value": "UPDATE_LAUNCH_TEMPLATE_END" + }, + { + "name": "UPDATE_LAUNCH_TEMPLATE_FAILED", + "value": "UPDATE_LAUNCH_TEMPLATE_FAILED" + }, + { + "name": "NETWORK_RECOVERY_FAIL", + "value": "NETWORK_RECOVERY_FAIL" } ] } @@ -3740,6 +4264,12 @@ "traits": { "smithy.api#documentation": "Properties of a conversion job
" } + }, + "eventResourceData": { + "target": "com.amazonaws.drs#EventResourceData", + "traits": { + "smithy.api#documentation": "Properties of resource related to a job event.
" + } } }, "traits": { @@ -3974,6 +4504,12 @@ "traits": { "smithy.api#documentation": "Licensing.
" } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" + } } }, "traits": { @@ -4572,6 +5108,46 @@ } } }, + "com.amazonaws.drs#ParticipatingResource": { + "type": "structure", + "members": { + "participatingResourceID": { + "target": "com.amazonaws.drs#ParticipatingResourceID", + "traits": { + "smithy.api#documentation": "The ID of a participating resource.
" + } + }, + "launchStatus": { + "target": "com.amazonaws.drs#LaunchStatus", + "traits": { + "smithy.api#documentation": "The launch status of a participating resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a resource participating in an asynchronous Job.
" + } + }, + "com.amazonaws.drs#ParticipatingResourceID": { + "type": "union", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "Source Network ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "ID of a resource participating in an asynchronous Job.
" + } + }, + "com.amazonaws.drs#ParticipatingResources": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#ParticipatingResource" + } + }, "com.amazonaws.drs#ParticipatingServer": { "type": "structure", "members": { @@ -5277,17 +5853,79 @@ } } }, - "com.amazonaws.drs#RecoverySnapshot": { + "com.amazonaws.drs#RecoveryLifeCycle": { "type": "structure", "members": { - "snapshotID": { - "target": "com.amazonaws.drs#RecoverySnapshotID", + "apiCallDateTime": { + "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "The ID of the Recovery Snapshot.
", - "smithy.api#required": {} + "smithy.api#documentation": "The date and time the last Source Network recovery was initiated.
", + "smithy.api#timestampFormat": "date-time" } }, - "sourceServerID": { + "jobID": { + "target": "com.amazonaws.drs#JobID", + "traits": { + "smithy.api#documentation": "The ID of the Job that was used to last recover the Source Network.
" + } + }, + "lastRecoveryResult": { + "target": "com.amazonaws.drs#RecoveryResult", + "traits": { + "smithy.api#documentation": "The status of the last recovery status of this Source Network.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the Source Network recovery Lifecycle.
" + } + }, + "com.amazonaws.drs#RecoveryResult": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NOT_STARTED", + "name": "NOT_STARTED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "SUCCESS", + "name": "SUCCESS" + }, + { + "value": "FAIL", + "name": "FAIL" + }, + { + "value": "PARTIAL_SUCCESS", + "name": "PARTIAL_SUCCESS" + }, + { + "value": "ASSOCIATE_SUCCESS", + "name": "ASSOCIATE_SUCCESS" + }, + { + "value": "ASSOCIATE_FAIL", + "name": "ASSOCIATE_FAIL" + } + ] + } + }, + "com.amazonaws.drs#RecoverySnapshot": { + "type": "structure", + "members": { + "snapshotID": { + "target": "com.amazonaws.drs#RecoverySnapshotID", + "traits": { + "smithy.api#documentation": "The ID of the Recovery Snapshot.
", + "smithy.api#required": {} + } + }, + "sourceServerID": { "target": "com.amazonaws.drs#SourceServerID", "traits": { "smithy.api#documentation": "The ID of the Source Server that the snapshot was taken for.
", @@ -5506,6 +6144,10 @@ { "value": "CUSTOM", "name": "CUSTOM" + }, + { + "value": "NONE", + "name": "NONE" } ] } @@ -5797,6 +6439,29 @@ } } }, + "com.amazonaws.drs#ReplicationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "PROTECTED", + "name": "PROTECTED" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, "com.amazonaws.drs#ResourceNotFoundException": { "type": "structure", "members": { @@ -5957,6 +6622,16 @@ "smithy.api#pattern": "^sg-[0-9a-fA-F]{8,}$" } }, + "com.amazonaws.drs#SensitiveBoundedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.drs#ServiceQuotaExceededException": { "type": "structure", "members": { @@ -6032,6 +6707,178 @@ "smithy.api#documentation": "Properties of the cloud environment where this Source Server originated from.
" } }, + "com.amazonaws.drs#SourceNetwork": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "Source Network ID.
" + } + }, + "sourceVpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "VPC ID protected by the Source Network.
" + } + }, + "arn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "The ARN of the Source Network.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "A list of tags associated with the Source Network.
" + } + }, + "replicationStatus": { + "target": "com.amazonaws.drs#ReplicationStatus", + "traits": { + "smithy.api#documentation": "Status of Source Network Replication. Possible values:\n (a) STOPPED - Source Network is not replicating.\n (b) IN_PROGRESS - Source Network is being replicated.\n (c) PROTECTED - Source Network was replicated successfully and is being synchronized for changes.\n (d) ERROR - Source Network replication has failed
" + } + }, + "replicationStatusDetails": { + "target": "com.amazonaws.drs#SensitiveBoundedString", + "traits": { + "smithy.api#documentation": "Error details in case Source Network replication status is ERROR.
" + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "CloudFormation stack name that was deployed for recovering the Source Network.
" + } + }, + "sourceRegion": { + "target": "com.amazonaws.drs#AwsRegion", + "traits": { + "smithy.api#documentation": "Region containing the VPC protected by the Source Network.
" + } + }, + "sourceAccountID": { + "target": "com.amazonaws.drs#AccountID", + "traits": { + "smithy.api#documentation": "Account ID containing the VPC protected by the Source Network.
" + } + }, + "lastRecovery": { + "target": "com.amazonaws.drs#RecoveryLifeCycle", + "traits": { + "smithy.api#documentation": "An object containing information regarding the last recovery of the Source Network.
" + } + }, + "launchedVpcID": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "ID of the recovered VPC following Source Network recovery.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The ARN of the Source Network.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.drs#SourceNetworkResource" + } + ] + } + }, + "com.amazonaws.drs#SourceNetworkData": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "Source Network ID.
" + } + }, + "sourceVpc": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "VPC ID protected by the Source Network.
" + } + }, + "targetVpc": { + "target": "com.amazonaws.drs#VpcID", + "traits": { + "smithy.api#documentation": "ID of the recovered VPC following Source Network recovery.
" + } + }, + "stackName": { + "target": "com.amazonaws.drs#LargeBoundedString", + "traits": { + "smithy.api#documentation": "CloudFormation stack name that was deployed for recovering the Source Network.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties of Source Network related to a job event.
" + } + }, + "com.amazonaws.drs#SourceNetworkID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 20 + }, + "smithy.api#pattern": "^sn-[0-9a-zA-Z]{17}$" + } + }, + "com.amazonaws.drs#SourceNetworkResource": { + "type": "resource", + "identifiers": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID" + } + }, + "create": { + "target": "com.amazonaws.drs#CreateSourceNetwork" + }, + "delete": { + "target": "com.amazonaws.drs#DeleteSourceNetwork" + }, + "list": { + "target": "com.amazonaws.drs#DescribeSourceNetworks" + }, + "operations": [ + { + "target": "com.amazonaws.drs#AssociateSourceNetworkStack" + }, + { + "target": "com.amazonaws.drs#ExportSourceNetworkCfnTemplate" + }, + { + "target": "com.amazonaws.drs#StartSourceNetworkReplication" + }, + { + "target": "com.amazonaws.drs#StopSourceNetworkReplication" + } + ], + "collectionOperations": [ + { + "target": "com.amazonaws.drs#StartSourceNetworkRecovery" + } + ], + "traits": { + "aws.api#arn": { + "template": "source-network/{sourceNetworkID}" + }, + "aws.iam#conditionKeys": [ + "aws:ResourceTag" + ], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.drs#SourceNetworksList": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#SourceNetwork" + } + }, "com.amazonaws.drs#SourceProperties": { "type": "structure", "members": { @@ -6169,6 +7016,12 @@ "traits": { "smithy.api#documentation": "For EC2-originated Source Servers which have been failed over and then failed back, this value will mean the ARN of the Source Server on the opposite replication direction.
" } + }, + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "ID of the Source Network which is protecting this Source Server's network.
" + } } }, "traits": { @@ -6606,6 +7459,201 @@ } } }, + "com.amazonaws.drs#StartSourceNetworkRecovery": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "aws.iam#requiredActions": [ + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "ec2:ModifyLaunchTemplate", + "ec2:CreateLaunchTemplateVersion", + "ec2:DescribeVpcs", + "ec2:DescribeSubnets", + "ec2:DescribeSecurityGroups", + "ec2:DescribeLaunchTemplates", + "ec2:DescribeLaunchTemplateVersions", + "cloudformation:DescribeStacks", + "cloudformation:UpdateStack", + "cloudformation:CreateStack", + "cloudformation:DescribeStackResource", + "cloudformation:DescribeStacks", + "drs:GetLaunchConfiguration", + "s3:PutObject", + "s3:GetObject" + ], + "smithy.api#documentation": "Deploy VPC for the specified Source Network and modify launch templates to use this network. The VPC will be deployed using a dedicated CloudFormation stack.
", + "smithy.api#http": { + "uri": "/StartSourceNetworkRecovery", + "method": "POST", + "code": 202 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequest": { + "type": "structure", + "members": { + "sourceNetworks": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntries", + "traits": { + "smithy.api#documentation": "The Source Networks that we want to start a Recovery Job for.
", + "smithy.api#required": {} + } + }, + "deployAsNew": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Don't update existing CloudFormation Stack, recover the network using a new stack.
" + } + }, + "tags": { + "target": "com.amazonaws.drs#TagsMap", + "traits": { + "smithy.api#documentation": "The tags to be associated with the Source Network recovery Job.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntry" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryRequestNetworkEntry": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "The ID of the Source Network you want to recover.
", + "smithy.api#required": {} + } + }, + "cfnStackName": { + "target": "com.amazonaws.drs#CfnStackName", + "traits": { + "smithy.api#documentation": "CloudFormation stack name to be used for recovering the network.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object representing the Source Network to recover.
" + } + }, + "com.amazonaws.drs#StartSourceNetworkRecoveryResponse": { + "type": "structure", + "members": { + "job": { + "target": "com.amazonaws.drs#Job", + "traits": { + "smithy.api#documentation": "The Source Network recovery Job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StartSourceNetworkReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StartSourceNetworkReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + } + ], + "traits": { + "smithy.api#documentation": "Starts replication for a Source Network. This action would make the Source Network protected.
", + "smithy.api#http": { + "uri": "/StartSourceNetworkReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StartSourceNetworkReplicationRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "ID of the Source Network to replicate.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StartSourceNetworkReplicationResponse": { + "type": "structure", + "members": { + "sourceNetwork": { + "target": "com.amazonaws.drs#SourceNetwork", + "traits": { + "smithy.api#documentation": "Source Network which was requested for replication.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#StopFailback": { "type": "operation", "input": { @@ -6706,6 +7754,72 @@ } } }, + "com.amazonaws.drs#StopSourceNetworkReplication": { + "type": "operation", + "input": { + "target": "com.amazonaws.drs#StopSourceNetworkReplicationRequest" + }, + "output": { + "target": "com.amazonaws.drs#StopSourceNetworkReplicationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.drs#ConflictException" + }, + { + "target": "com.amazonaws.drs#InternalServerException" + }, + { + "target": "com.amazonaws.drs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.drs#ThrottlingException" + }, + { + "target": "com.amazonaws.drs#UninitializedAccountException" + }, + { + "target": "com.amazonaws.drs#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops replication for a Source Network. This action would make the Source Network unprotected.
", + "smithy.api#http": { + "uri": "/StopSourceNetworkReplication", + "method": "POST", + "code": 200 + } + } + }, + "com.amazonaws.drs#StopSourceNetworkReplicationRequest": { + "type": "structure", + "members": { + "sourceNetworkID": { + "target": "com.amazonaws.drs#SourceNetworkID", + "traits": { + "smithy.api#documentation": "ID of the Source Network to stop replication.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.drs#StopSourceNetworkReplicationResponse": { + "type": "structure", + "members": { + "sourceNetwork": { + "target": "com.amazonaws.drs#SourceNetwork", + "traits": { + "smithy.api#documentation": "Source Network which was requested to stop replication.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.drs#StrictlyPositiveInteger": { "type": "integer", "traits": { @@ -7230,6 +8344,12 @@ "traits": { "smithy.api#documentation": "Licensing.
" } + }, + "exportBucketArn": { + "target": "com.amazonaws.drs#ARN", + "traits": { + "smithy.api#documentation": "S3 bucket ARN to export Source Network templates.
" + } } } }, @@ -7628,6 +8748,16 @@ "value": { "target": "com.amazonaws.drs#PositiveInteger" } + }, + "com.amazonaws.drs#VpcID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 21 + }, + "smithy.api#pattern": "^vpc-[0-9a-fA-F]{8,}$" + } } } } \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json index 8c04f216c79..aefb201e259 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json @@ -174,7 +174,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a DescribeStream operation.
Represents the input of a DescribeStream operation.
Represents the output of a DescribeStream operation.
Represents the output of a DescribeStream operation.
Amazon DynamoDB Streams provides API actions for accessing streams and processing\n stream records. To learn more about application development with Streams, see Capturing\n Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer\n Guide.
", + "smithy.api#documentation": "Amazon DynamoDB Streams provides API actions for accessing streams and processing\n stream records. To learn more about application development with Streams, see Capturing\n Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer\n Guide.
", "smithy.api#title": "Amazon DynamoDB Streams", "smithy.api#xmlNamespace": { "uri": "http://dynamodb.amazonaws.com/doc/2012-08-10/" @@ -1467,7 +1469,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a GetRecords operation.
Represents the input of a GetRecords operation.
Represents the output of a GetRecords operation.
Represents the output of a GetRecords operation.
Represents the input of a GetShardIterator operation.
Represents the input of a GetShardIterator operation.
Represents the output of a GetShardIterator operation.
Represents the output of a GetShardIterator operation.
The role that this key attribute will assume:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range\n attribute. The term \"range attribute\" derives from the way DynamoDB\n stores items with the same partition key physically close together, in sorted order\n by the sort key value.
\nThe role that this key attribute will assume:
\n\n HASH - partition key
\n RANGE - sort key
The partition key of an item is also known as its hash\n attribute. The term \"hash attribute\" derives from DynamoDB's usage of\n an internal hash function to evenly distribute data items across partitions, based\n on their partition key values.
\nThe sort key of an item is also known as its range\n attribute. The term \"range attribute\" derives from the way DynamoDB\n stores items with the same partition key physically close together, in sorted order\n by the sort key value.
\nThere is no limit to the number of daily on-demand backups that can be taken.
\nFor most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.
\nWhen importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
\nThere is a soft account quota of 2,500 tables.
", + "smithy.api#documentation": "There is no limit to the number of daily on-demand backups that can be taken.
\nFor most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.
\nWhen importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
\nThere is a soft account quota of 2,500 tables.
\nGetRecords was called with a value of more than 1000 for the limit request parameter.
\nMore than 2 processes are reading from the same streams shard at the same time. Exceeding\n this limit may result in request throttling.
", "smithy.api#error": "client" } }, @@ -1721,7 +1727,8 @@ } }, "traits": { - "smithy.api#documentation": "Represents the input of a ListStreams operation.
Represents the input of a ListStreams operation.
Represents the output of a ListStreams operation.
Represents the output of a ListStreams operation.
The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
The Amazon Web Services service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
A timestamp, in ISO 8601 format, for this stream.
\nNote that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
\nthe table name
\nthe StreamLabel\n
A timestamp, in ISO 8601 format, for this stream.
\nNote that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:
the Amazon Web Services customer ID.
\nthe table name
\nthe StreamLabel\n
A timestamp, in ISO 8601 format, for this stream.
\nNote that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:
the AWS customer ID.
\nthe table name
\nthe StreamLabel\n
A timestamp, in ISO 8601 format, for this stream.
\nNote that LatestStreamLabel is not a unique identifier for the stream, because it is\n possible that a stream from another table might have the same timestamp. However, the\n combination of the following three elements is guaranteed to be unique:
the Amazon Web Services customer ID.
\nthe table name
\nthe StreamLabel\n
The approximate date and time when the stream record was created, in UNIX epoch time format.
" + "smithy.api#documentation": "The approximate date and time when the stream record was created, in UNIX epoch time format and rounded down to the closest second.
" } }, "Keys": { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index adb4cf00ebc..7c5a2d76787 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -833,7 +833,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": false }, - "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, or an internal processing\n failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
" + "smithy.api#documentation": "The BatchGetItem operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. BatchGetItem returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested,\n or an internal processing failure occurs. If a partial result is returned, the operation returns a value for\n UnprocessedKeys. You can use this value to retry the operation starting\n with the next item to get.
If you request more than 100 items, BatchGetItem returns a\n ValidationException with the message \"Too many items requested for\n the BatchGetItem call.\"
For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate UnprocessedKeys value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.
If none of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n BatchGetItem returns a\n ProvisionedThroughputExceededException. If at least\n one of the items is successfully processed, then\n BatchGetItem completes successfully, while returning the keys of the\n unread items in UnprocessedKeys.
If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, we strongly recommend that you use an exponential\n backoff algorithm. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.
\nFor more information, see Batch Operations and Error Handling in the Amazon DynamoDB\n Developer Guide.
\nBy default, BatchGetItem performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n ConsistentRead to true for any or all tables.
In order to minimize response latency, BatchGetItem may retrieve items in\n parallel.
When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the ProjectionExpression parameter.
If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see Working with Tables in the Amazon DynamoDB Developer\n Guide.
" } }, "com.amazonaws.dynamodb#BatchGetItemInput": { @@ -6732,7 +6732,7 @@ } }, "traits": { - "smithy.api#documentation": "There is no limit to the number of daily on-demand backups that can be taken.
\nFor most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.
\nWhen importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
\nThere is a soft account quota of 2,500 tables.
", + "smithy.api#documentation": "There is no limit to the number of daily on-demand backups that can be taken.
\nFor most purposes, up to 500 simultaneous table operations are allowed per account. These operations\n include CreateTable, UpdateTable,\n DeleteTable,UpdateTimeToLive,\n RestoreTableFromBackup, and RestoreTableToPointInTime.
When you are creating a table with one or more secondary\n indexes, you can have up to 250 such requests running at a time. However, if the table or\n index specifications are complex, then DynamoDB might temporarily reduce the number\n of concurrent operations.
\nWhen importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.
\nThere is a soft account quota of 2,500 tables.
\nGetRecords was called with a value of more than 1000 for the limit request parameter.
\nMore than 2 processes are reading from the same streams shard at the same time. Exceeding\n this limit may result in request throttling.
", "smithy.api#error": "client" } }, @@ -7689,14 +7689,14 @@ "ReadCapacityUnits": { "target": "com.amazonaws.dynamodb#PositiveLongObject", "traits": { - "smithy.api#documentation": "The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of strongly consistent reads consumed per second before DynamoDB\n returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The maximum number of writes consumed per second before DynamoDB returns a\n ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB\n Developer Guide.
If read/write capacity mode is PAY_PER_REQUEST the value is set to\n 0.
The ID representing the allocation of the address for use with EC2-VPC.
", + "smithy.api#documentation": "The ID representing the allocation of the address.
", "smithy.api#xmlName": "allocationId" } }, @@ -1184,7 +1184,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "The ID representing the association of the address with an instance in a VPC.
", + "smithy.api#documentation": "The ID representing the association of the address with an instance.
", "smithy.api#xmlName": "associationId" } }, @@ -1192,7 +1192,7 @@ "target": "com.amazonaws.ec2#DomainType", "traits": { "aws.protocols#ec2QueryName": "Domain", - "smithy.api#documentation": "Indicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).
The network (vpc).
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. 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.
\nIf you release an Elastic IP address, you might be able to recover it. You cannot recover\n an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify\n it in this operation.
\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, \n to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
" } }, "com.amazonaws.ec2#AllocateAddressRequest": { @@ -1544,13 +1544,13 @@ "Domain": { "target": "com.amazonaws.ec2#DomainType", "traits": { - "smithy.api#documentation": "Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.
\nDefault: If the Region supports EC2-Classic, the default is standard. Otherwise, the default\n is vpc.
The network (vpc).
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
" + "smithy.api#documentation": "The Elastic IP address to recover or an IPv4 address from an address pool.
" } }, "PublicIpv4Pool": { @@ -1608,7 +1608,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AllocationId", - "smithy.api#documentation": "[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
", + "smithy.api#documentation": "The ID that represents the allocation of the Elastic IP address.
", "smithy.api#xmlName": "allocationId" } }, @@ -1632,7 +1632,7 @@ "target": "com.amazonaws.ec2#DomainType", "traits": { "aws.protocols#ec2QueryName": "Domain", - "smithy.api#documentation": "Indicates whether the Elastic IP address is for use with instances in a VPC (vpc) or\n\t\t\t\tinstances in EC2-Classic (standard).
The network (vpc).
The carrier IP address. This option is only available for network interfaces which reside\n in a subnet in a Wavelength Zone (for example an EC2 instance).
", + "smithy.api#documentation": "The carrier IP address. This option is only available for network interfaces that reside\n in a subnet in a Wavelength Zone.
", "smithy.api#xmlName": "carrierIp" } } @@ -1726,8 +1726,7 @@ "aws.protocols#ec2QueryName": "Quantity", "smithy.api#clientOptional": {}, "smithy.api#default": 0, - "smithy.api#documentation": "The number of Dedicated Hosts to allocate to your account with these\n parameters.
", - "smithy.api#required": {}, + "smithy.api#documentation": "The number of Dedicated Hosts to allocate to your account with these parameters. If you are \n allocating the Dedicated Hosts on an Outpost, and you specify AssetIds, \n you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each \n specified hardware asset. If you specify both AssetIds and \n Quantity, then the value that you specify for \n Quantity must be equal to the number of asset IDs specified.
", "smithy.api#xmlName": "quantity" } }, @@ -1747,7 +1746,7 @@ "OutpostArn": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate\n the Dedicated Host.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which to allocate\n the Dedicated Host. If you specify OutpostArn, you can \n optionally specify AssetIds.
\nIf you are allocating the Dedicated Host in a Region, omit this parameter.
" } }, "HostMaintenance": { @@ -1755,6 +1754,13 @@ "traits": { "smithy.api#documentation": "Indicates whether to enable or disable host maintenance for the Dedicated Host. For\n more information, see Host\n maintenance in the Amazon EC2 User Guide.
" } + }, + "AssetIds": { + "target": "com.amazonaws.ec2#AssetIdList", + "traits": { + "smithy.api#documentation": "The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting \n specific hardware assets on an Outpost can help to minimize latency between your workloads. \n This parameter is supported only if you specify OutpostArn. \n If you are allocating the Dedicated Hosts in a Region, omit this parameter.
\nIf you specify this parameter, you can omit Quantity. \n In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware \n asset.
\nIf you specify both AssetIds and \n Quantity, then the value for \n Quantity must be equal to the number of asset IDs \n specified.
\nAllocate a CIDR from an IPAM pool. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
\nThis action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
\nAllocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
\nIn IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see Allocate CIDRs in the Amazon VPC IPAM User Guide.
\nThis action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool.
\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 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.
\nIf 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[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.
\n[EC2-VPC] The allocation ID. This is required for EC2-VPC.
" + "smithy.api#documentation": "The allocation ID. This is required.
" } }, "InstanceId": { "target": "com.amazonaws.ec2#InstanceId", "traits": { - "smithy.api#documentation": "The ID of the instance. The instance must have exactly one attached network interface.\n For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.\n For EC2-Classic, you must specify an instance ID and the instance must be in the running\n state.
" + "smithy.api#documentation": "The ID of the instance. The instance must have exactly one attached network interface.\n You can specify either the instance ID or the network interface ID, but not both.
" } }, "PublicIp": { "target": "com.amazonaws.ec2#EipAllocationPublicIp", "traits": { - "smithy.api#documentation": "[EC2-Classic] The Elastic IP address to associate with the instance. This is required for\n EC2-Classic.
" + "smithy.api#documentation": "Deprecated.
" } }, "AllowReassociation": { @@ -5991,7 +6015,7 @@ "aws.protocols#ec2QueryName": "AllowReassociation", "smithy.api#clientOptional": {}, "smithy.api#default": false, - "smithy.api#documentation": "[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
", + "smithy.api#documentation": "Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
", "smithy.api#xmlName": "allowReassociation" } }, @@ -6009,7 +6033,7 @@ "target": "com.amazonaws.ec2#NetworkInterfaceId", "traits": { "aws.protocols#ec2QueryName": "NetworkInterfaceId", - "smithy.api#documentation": "[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
\nFor EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
", + "smithy.api#documentation": "The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
\nYou can specify either the instance ID or the network interface ID, but not both.
", "smithy.api#xmlName": "networkInterfaceId" } }, @@ -6017,7 +6041,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "PrivateIpAddress", - "smithy.api#documentation": "[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", + "smithy.api#documentation": "The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
", "smithy.api#xmlName": "privateIpAddress" } } @@ -6033,7 +6057,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "AssociationId", - "smithy.api#documentation": "[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
", + "smithy.api#documentation": "The ID that represents the association of the Elastic IP address with an instance.
", "smithy.api#xmlName": "associationId" } } @@ -8342,6 +8366,9 @@ "smithy.api#documentation": "Describes Availability Zones, Local Zones, and Wavelength Zones.
" } }, + "com.amazonaws.ec2#AvailabilityZoneId": { + "type": "string" + }, "com.amazonaws.ec2#AvailabilityZoneList": { "type": "list", "member": { @@ -13031,7 +13058,7 @@ "target": "com.amazonaws.ec2#AmdSevSnpSpecification", "traits": { "aws.protocols#ec2QueryName": "AmdSevSnp", - "smithy.api#documentation": "Indicates whether the instance is enabled for AMD SEV-SNP.
", + "smithy.api#documentation": "Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see \n AMD SEV-SNP.
", "smithy.api#xmlName": "amdSevSnp" } } @@ -13062,7 +13089,7 @@ "AmdSevSnp": { "target": "com.amazonaws.ec2#AmdSevSnpSpecification", "traits": { - "smithy.api#documentation": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only.
" + "smithy.api#documentation": "Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported \n with M6a, R6a, and C6a instance types only. For more information, see \n AMD SEV-SNP.
" } } }, @@ -13292,13 +13319,13 @@ } }, "AvailabilityZone": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#AvailabilityZoneName", "traits": { "smithy.api#documentation": "The Availability Zone in which to create the Capacity Reservation.
" } }, "AvailabilityZoneId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#AvailabilityZoneId", "traits": { "smithy.api#documentation": "The ID of the Availability Zone in which to create the Capacity Reservation.
" } @@ -14189,7 +14216,7 @@ "target": "com.amazonaws.ec2#CreateFleetResult" }, "traits": { - "smithy.api#documentation": "Launches an EC2 Fleet.
\nYou can create a single EC2 Fleet that includes multiple launch specifications that vary by\n instance type, AMI, Availability Zone, or subnet.
\nFor more information, see EC2 Fleet in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances.\n Instances are launched immediately if there is available capacity.
\nA single EC2 Fleet can include multiple launch specifications that vary by instance type,\n AMI, Availability Zone, or subnet.
\nFor more information, see EC2 Fleet in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#CreateFleetError": { @@ -14769,6 +14796,95 @@ "smithy.api#output": {} } }, + "com.amazonaws.ec2#CreateInstanceConnectEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest" + }, + "output": { + "target": "com.amazonaws.ec2#CreateInstanceConnectEndpointResult" + }, + "traits": { + "smithy.api#documentation": "Creates an EC2 Instance Connect Endpoint.
\nAn EC2 Instance Connect Endpoint allows you to connect to a resource, without\n requiring the resource to have a public IPv4 address. For more information, see Connect to your resources without requiring a public IPv4 address using EC2\n Instance Connect Endpoint in the Amazon EC2 User\n Guide.
" + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.ec2#SecurityGroupIdStringListRequest", + "traits": { + "smithy.api#documentation": "One or more security groups to associate with the endpoint. If you don't specify a security group, \n the default security group for your VPC will be associated with the endpoint.
", + "smithy.api#xmlName": "SecurityGroupId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true\n
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "TagSpecifications": { + "target": "com.amazonaws.ec2#TagSpecificationList", + "traits": { + "smithy.api#documentation": "The tags to apply to the EC2 Instance Connect Endpoint during creation.
", + "smithy.api#xmlName": "TagSpecification" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#CreateInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "Information about the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + }, + "ClientToken": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "ClientToken", + "smithy.api#documentation": "Unique, case-sensitive idempotency token provided by the client in the the request.
", + "smithy.api#xmlName": "clientToken" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#CreateInstanceEventWindow": { "type": "operation", "input": { @@ -16622,7 +16738,7 @@ "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 interface, efa, and trunk.
Deletes the specified EC2 Instance Connect Endpoint.
" + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the EC2 Instance Connect Endpoint to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DeleteInstanceConnectEndpointResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoint": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpoint", + "smithy.api#documentation": "Information about the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "instanceConnectEndpoint" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ec2#DeleteInstanceEventWindow": { "type": "operation", "input": { @@ -25403,7 +25571,7 @@ "target": "com.amazonaws.ec2#DescribeAccountAttributesResult" }, "traits": { - "smithy.api#documentation": "Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n supported-platforms: Indicates whether your account can launch instances\n into EC2-Classic and EC2-VPC, or only into EC2-VPC.
\n default-vpc: The ID of the default VPC for your account, or\n none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-Classic.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with 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 EC2 User Guide.
\nDescribes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n default-vpc: The ID of the default VPC for your account, or none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n supported-platforms: This attribute is deprecated.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
", + "smithy.api#documentation": "Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
\nWhen you transfer an Elastic IP address, there is a two-step handshake\n between the source and transfer Amazon Web Services accounts. When the source account starts the transfer,\n the transfer account has seven days to accept the Elastic IP address\n transfer. During those seven days, the source account can view the\n pending transfer by using this action. After seven days, the\n transfer expires and ownership of the Elastic IP\n address returns to the source\n account. Accepted transfers are visible to the source account for three days\n after the transfers have been accepted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -25546,7 +25714,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. 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.
" } }, "com.amazonaws.ec2#DescribeAddressesAttribute": { @@ -25640,7 +25808,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. Filter names and values are case-sensitive.
\n\n allocation-id - [EC2-VPC] The allocation ID for the address.
\n association-id - [EC2-VPC] The association ID for the address.
\n domain - Indicates whether the address is for use in EC2-Classic (standard) \n or in a VPC (vpc).
\n instance-id - The ID of the instance the address is associated with, if any.
\n network-border-group - A unique set of Availability Zones, Local Zones,\n or Wavelength Zones from where Amazon Web Services advertises IP addresses.
\n network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
\n network-interface-owner-id - The Amazon Web Services account ID of the owner.
\n private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
\n public-ip - The Elastic IP address, or the carrier IP address.
\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.
One or more filters. Filter names and values are case-sensitive.
\n\n allocation-id - The allocation ID for the address.
\n association-id - The association ID for the address.
\n instance-id - The ID of the instance the address is associated with, if any.
\n network-border-group - A unique set of Availability Zones, Local Zones,\n or Wavelength Zones from where Amazon Web Services advertises IP addresses.
\n network-interface-id - The ID of the network interface that the address is associated with, if any.
\n network-interface-owner-id - The Amazon Web Services account ID of the owner.
\n private-ip-address - The private IP address associated with the Elastic IP address.
\n public-ip - The Elastic IP address, or the carrier IP address.
\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.
[EC2-VPC] Information about the allocation IDs.
", + "smithy.api#documentation": "Information about the allocation IDs.
", "smithy.api#xmlName": "AllocationId" } }, @@ -29644,6 +29812,92 @@ "smithy.api#input": {} } }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest" + }, + "output": { + "target": "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult" + }, + "traits": { + "smithy.api#documentation": "Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "InstanceConnectEndpoints", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The maximum number of items to return for this request.\n To get the next page of items, make another request with the token returned in the output.\n\t For more information, see Pagination.
" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "smithy.api#documentation": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" + } + }, + "Filters": { + "target": "com.amazonaws.ec2#FilterList", + "traits": { + "smithy.api#documentation": "One or more filters.
\n\n instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.
\n state - The state of the EC2 Instance Connect Endpoint (create-in-progress | create-complete | create-failed | \n delete-in-progress | delete-complete | delete-failed).
\n subnet-id - The ID of the subnet in which the EC2 Instance\n Connect Endpoint was created.
\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 tag-value - The value of a tag assigned to the resource. Use this filter to find all resources \n that have a tag with a specific value, regardless of tag key.
\n vpc-id - The ID of the VPC in which the EC2 Instance Connect\n Endpoint was created.
One or more EC2 Instance Connect Endpoint IDs.
", + "smithy.api#xmlName": "InstanceConnectEndpointId" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ec2#DescribeInstanceConnectEndpointsResult": { + "type": "structure", + "members": { + "InstanceConnectEndpoints": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointSet", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointSet", + "smithy.api#documentation": "Information about the EC2 Instance Connect Endpoints.
", + "smithy.api#xmlName": "instanceConnectEndpointSet" + } + }, + "NextToken": { + "target": "com.amazonaws.ec2#NextToken", + "traits": { + "aws.protocols#ec2QueryName": "NextToken", + "smithy.api#documentation": "The token to include in another request to get the next page of items. This value is null when there\n are no more items to return.
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type (true | false).
\n burstable-performance-supported - Indicates whether it is a burstable\n performance instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported | unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in\n GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is encrypted at rest \n (required | supported | unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported |\n unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage available from all local\n instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic \n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance type \n automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per\n network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per\n network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance type.
\n vcpu-info.default-threads-per-core - The default number of threads per core for the instance\n type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.\n For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type (true | false).
\n burstable-performance-supported - Indicates whether it is a burstable\n performance instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported | unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in\n GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-support - Indicates whether data is encrypted at rest \n (required | supported | unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported |\n unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage available from all local\n instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic \n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance type \n automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per\n network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per\n network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
\n network-info.maximum-network-cards - The maximum number of network cards per\n instance.
\n network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
\n processor-info.supported-features - The supported CPU features (amd-sev-snp).
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance type.
\n vcpu-info.default-threads-per-core - The default number of threads per core for the instance\n type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.\n For example, \"1\" or \"1,2\".
The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
", + "smithy.api#documentation": "The instance type. For more information, see Instance types in the Amazon EC2 User Guide.
\nWhen you change your EBS-backed instance type, instance restart or replacement behavior depends on the \n \t\tinstance type compatibility between the old and new types. An instance that's backed by an instance store volume \n \t\tis always replaced. For more information, see Change the instance type in the \n \t\tAmazon EC2 User Guide.
", "smithy.api#xmlName": "instanceTypeSet" } }, @@ -31990,7 +32244,7 @@ "target": "com.amazonaws.ec2#DescribeMovingAddressesResult" }, "traits": { - "smithy.api#documentation": "Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
", + "smithy.api#documentation": "This action is deprecated.
\nDescribes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. \n This request does not return information about any other Elastic IP addresses in your account.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -40736,7 +40990,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\nAn 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.
\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.
" + "smithy.api#documentation": "Disassociates an Elastic IP address from the instance or network interface it's associated with.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
" } }, "com.amazonaws.ec2#DisassociateAddressRequest": { @@ -40745,13 +40999,13 @@ "AssociationId": { "target": "com.amazonaws.ec2#ElasticIpAssociationId", "traits": { - "smithy.api#documentation": "[EC2-VPC] The association ID. Required for EC2-VPC.
" + "smithy.api#documentation": "The association ID. This parameter is required.
" } }, "PublicIp": { "target": "com.amazonaws.ec2#EipAllocationPublicIp", "traits": { - "smithy.api#documentation": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" + "smithy.api#documentation": "Deprecated.
" } }, "DryRun": { @@ -42319,6 +42573,177 @@ } } }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpoint": { + "type": "structure", + "members": { + "OwnerId": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "OwnerId", + "smithy.api#documentation": "The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "ownerId" + } + }, + "InstanceConnectEndpointId": { + "target": "com.amazonaws.ec2#InstanceConnectEndpointId", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointId", + "smithy.api#documentation": "The ID of the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "instanceConnectEndpointId" + } + }, + "InstanceConnectEndpointArn": { + "target": "com.amazonaws.ec2#ResourceArn", + "traits": { + "aws.protocols#ec2QueryName": "InstanceConnectEndpointArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "instanceConnectEndpointArn" + } + }, + "State": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpointState", + "traits": { + "aws.protocols#ec2QueryName": "State", + "smithy.api#documentation": "The current state of the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "state" + } + }, + "StateMessage": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "StateMessage", + "smithy.api#documentation": "The message for the current state of the EC2 Instance Connect Endpoint. \n Can include a failure message.
", + "smithy.api#xmlName": "stateMessage" + } + }, + "DnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "DnsName", + "smithy.api#documentation": "The DNS name of the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "dnsName" + } + }, + "FipsDnsName": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "FipsDnsName", + "smithy.api#documentation": "", + "smithy.api#xmlName": "fipsDnsName" + } + }, + "NetworkInterfaceIds": { + "target": "com.amazonaws.ec2#NetworkInterfaceIdSet", + "traits": { + "aws.protocols#ec2QueryName": "NetworkInterfaceIdSet", + "smithy.api#documentation": "The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2\n Instance Connect Endpoint.
", + "smithy.api#xmlName": "networkInterfaceIdSet" + } + }, + "VpcId": { + "target": "com.amazonaws.ec2#VpcId", + "traits": { + "aws.protocols#ec2QueryName": "VpcId", + "smithy.api#documentation": "The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
", + "smithy.api#xmlName": "vpcId" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "AvailabilityZone", + "smithy.api#documentation": "The Availability Zone of the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "availabilityZone" + } + }, + "CreatedAt": { + "target": "com.amazonaws.ec2#MillisecondDateTime", + "traits": { + "aws.protocols#ec2QueryName": "CreatedAt", + "smithy.api#documentation": "The date and time that the EC2 Instance Connect Endpoint was created.
", + "smithy.api#xmlName": "createdAt" + } + }, + "SubnetId": { + "target": "com.amazonaws.ec2#SubnetId", + "traits": { + "aws.protocols#ec2QueryName": "SubnetId", + "smithy.api#documentation": "The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
", + "smithy.api#xmlName": "subnetId" + } + }, + "PreserveClientIp": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PreserveClientIp", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether your client's IP address is preserved as the source. The value is true or false.
If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true\n
The security groups associated with the endpoint. If you didn't specify a security group, \n the default security group for your VPC is associated with the endpoint.
", + "smithy.api#xmlName": "securityGroupIdSet" + } + }, + "Tags": { + "target": "com.amazonaws.ec2#TagList", + "traits": { + "aws.protocols#ec2QueryName": "TagSet", + "smithy.api#documentation": "The tags assigned to the EC2 Instance Connect Endpoint.
", + "smithy.api#xmlName": "tagSet" + } + } + }, + "traits": { + "smithy.api#documentation": "The EC2 Instance Connect Endpoint.
" + } + }, + "com.amazonaws.ec2#Ec2InstanceConnectEndpointState": { + "type": "enum", + "members": { + "create_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-in-progress" + } + }, + "create_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-complete" + } + }, + "create_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "create-failed" + } + }, + "delete_in_progress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-in-progress" + } + }, + "delete_complete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-complete" + } + }, + "delete_failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "delete-failed" + } + } + } + }, "com.amazonaws.ec2#EfaInfo": { "type": "structure", "members": { @@ -46312,7 +46737,7 @@ "target": "com.amazonaws.ec2#ImageId", "traits": { "aws.protocols#ec2QueryName": "ImageId", - "smithy.api#documentation": "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#documentation": "The ID of the AMI. An AMI is required to launch an instance. This parameter is only\n available for fleets of type instant. For fleets of type maintain\n and request, you must specify the AMI ID in the launch template.
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#documentation": "The ID of the AMI. An AMI is required to launch an instance. This parameter is only\n available for fleets of type instant. For fleets of type maintain\n and request, you must specify the AMI ID in the launch template.
Get a list of all the CIDR allocations in an IPAM pool.
\nIf you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
\nGet a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations.
\nIf you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
\nIndicates whether host maintenance is enabled or disabled for the Dedicated\n Host.
", "smithy.api#xmlName": "hostMaintenance" } + }, + "AssetId": { + "target": "com.amazonaws.ec2#AssetId", + "traits": { + "aws.protocols#ec2QueryName": "AssetId", + "smithy.api#documentation": "The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
", + "smithy.api#xmlName": "assetId" + } } }, "traits": { @@ -54851,6 +55284,28 @@ "smithy.api#documentation": "Information about the number of instances that can be launched onto the Dedicated\n Host.
" } }, + "com.amazonaws.ec2#InstanceConnectEndpointId": { + "type": "string" + }, + "com.amazonaws.ec2#InstanceConnectEndpointMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.ec2#InstanceConnectEndpointSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#Ec2InstanceConnectEndpoint", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#InstanceCount": { "type": "structure", "members": { @@ -64864,7 +65319,7 @@ "target": "com.amazonaws.ec2#FleetLaunchTemplateSpecification", "traits": { "aws.protocols#ec2QueryName": "LaunchTemplateSpecification", - "smithy.api#documentation": "The launch template.
", + "smithy.api#documentation": "The launch template to use. Make sure that the launch template does not contain the\n NetworkInterfaceId parameter because you can't specify a network interface\n ID in a Spot Fleet.
The tenancy for the instance.
\nFor T3 instances, you can't change the tenancy from dedicated to\n host, or from host to dedicated.\n Attempting to make one of these unsupported tenancy changes results in the\n InvalidTenancy error code.
The tenancy for the instance.
\nFor T3 instances, you must launch the instance on a Dedicated Host to use a\n tenancy of host. You can't change the tenancy from\n host to dedicated or default.\n Attempting to make one of these unsupported tenancy changes results in an\n InvalidRequest error code.
The ARN of the host resource group in which to place the instance.
" + "smithy.api#documentation": "The ARN of the host resource group in which to place the instance. The instance must\n have a tenancy of host to specify this parameter.
The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" } @@ -73542,7 +73997,8 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon Web Services Site-to-Site VPN tunnel options to modify.
" + "smithy.api#documentation": "The Amazon Web Services Site-to-Site VPN tunnel options to modify.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.ec2#MonitorInstances": { @@ -73654,7 +74110,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. 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 action is deprecated.
\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.
" } }, "com.amazonaws.ec2#MoveAddressToVpcRequest": { @@ -73801,7 +74257,7 @@ "target": "com.amazonaws.ec2#MoveStatus", "traits": { "aws.protocols#ec2QueryName": "MoveStatus", - "smithy.api#documentation": "The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
", + "smithy.api#documentation": "The status of the Elastic IP address that's being moved or restored.
", "smithy.api#xmlName": "moveStatus" } }, @@ -73815,7 +74271,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes 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.
\nThis action is deprecated.
\nDescribes the status of a moving Elastic IP address.
" } }, "com.amazonaws.ec2#MovingAddressStatusSet": { @@ -75609,6 +76065,15 @@ } } }, + "com.amazonaws.ec2#NetworkInterfaceIdSet": { + "type": "list", + "member": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#xmlName": "item" + } + } + }, "com.amazonaws.ec2#NetworkInterfaceIpv6Address": { "type": "structure", "members": { @@ -78439,7 +78904,7 @@ "target": "com.amazonaws.ec2#SupportedAdditionalProcessorFeatureList", "traits": { "aws.protocols#ec2QueryName": "SupportedFeatures", - "smithy.api#documentation": "Indicates whether the instance type supports AMD SEV-SNP. If the request returns \n amd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported.
Indicates whether the instance type supports AMD SEV-SNP. If the request returns \n amd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported. \n For more information, see \n AMD SEV-SNP.
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.
" + "smithy.api#documentation": "Releases the specified Elastic IP address.
\n[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.
\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.
After you release an Elastic IP address, you might be able to recover it.\n For more information, see AllocateAddress.
" } }, "com.amazonaws.ec2#ReleaseAddressRequest": { @@ -80366,13 +80831,13 @@ "AllocationId": { "target": "com.amazonaws.ec2#AllocationId", "traits": { - "smithy.api#documentation": "[EC2-VPC] The allocation ID. Required for EC2-VPC.
" + "smithy.api#documentation": "The allocation ID. This parameter is required.
" } }, "PublicIp": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" + "smithy.api#documentation": "Deprecated.
" } }, "NetworkBorderGroup": { @@ -80459,7 +80924,7 @@ "target": "com.amazonaws.ec2#ReleaseIpamPoolAllocationResult" }, "traits": { - "smithy.api#documentation": "Release an allocation within an IPAM pool. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n
\nAll EC2 API actions follow an eventual consistency model.
\nRelease an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.\n
\nAll EC2 API actions follow an eventual consistency model.
\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.
\nThis action is deprecated.
\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.
" } }, "com.amazonaws.ec2#RestoreAddressToClassicRequest": { @@ -85696,7 +86167,7 @@ "InstanceType": { "target": "com.amazonaws.ec2#InstanceType", "traits": { - "smithy.api#documentation": "The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.
\nDefault: m1.small\n
The instance type. For more information, see Instance types in the\n Amazon EC2 User Guide.
\nWhen you change your EBS-backed instance type, instance restart or replacement behavior depends on the \n \t\tinstance type compatibility between the old and new types. An instance that's backed by an instance store volume \n \t\tis always replaced. For more information, see Change the instance type in the \n \t\tAmazon EC2 User Guide.
\nDefault: m1.small\n
The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and the customer gateway.
", @@ -97976,10 +98471,24 @@ "traits": { "smithy.api#documentation": "Sends Verified Access logs to Kinesis.
" } + }, + "LogVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "smithy.api#documentation": "\n\t\t The logging version to use.\n\t
\nValid values: ocsf-0.1 | ocsf-1.0.0-rc.2\n
\n\t\t Include trust data sent by trust providers into the logs. \n\t
" + } } }, "traits": { - "smithy.api#documentation": "Describes the destinations for Verified Access logs.
" + "smithy.api#documentation": "Options for Verified Access logs.
" } }, "com.amazonaws.ec2#VerifiedAccessLogS3Destination": { @@ -98093,10 +98602,28 @@ "smithy.api#documentation": "Kinesis logging destination.
", "smithy.api#xmlName": "kinesisDataFirehose" } + }, + "LogVersion": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "LogVersion", + "smithy.api#documentation": "\n Describes current setting for the logging version.\n
", + "smithy.api#xmlName": "logVersion" + } + }, + "IncludeTrustContext": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "IncludeTrustContext", + "smithy.api#clientOptional": {}, + "smithy.api#default": false, + "smithy.api#documentation": "\n\t\t Describes current setting for including trust data into the logs.\n\t
", + "smithy.api#xmlName": "includeTrustContext" + } } }, "traits": { - "smithy.api#documentation": "Describes the destinations for Verified Access logs.
" + "smithy.api#documentation": "Describes the options for Verified Access logs.
" } }, "com.amazonaws.ec2#VerifiedAccessTrustProvider": { @@ -100343,7 +100870,7 @@ "type": "structure", "members": { "CustomerGatewayConfiguration": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#customerGatewayConfiguration", "traits": { "aws.protocols#ec2QueryName": "CustomerGatewayConfiguration", "smithy.api#documentation": "The configuration information for the VPN connection's customer gateway (in the native\n XML format). This element is always present in the CreateVpnConnection\n response; however, it's present in the DescribeVpnConnections response\n only if the VPN connection is in the pending or available\n state.
The pre-shared key (PSK) to establish initial authentication between the virtual\n private gateway and customer gateway.
\nConstraints: Allowed characters are alphanumeric characters, periods (.), and\n underscores (_). Must be between 8 and 64 characters in length and cannot start with\n zero (0).
" } @@ -101210,6 +101737,18 @@ } } }, + "com.amazonaws.ec2#customerGatewayConfiguration": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.ec2#preSharedKey": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, "com.amazonaws.ec2#scope": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json index 51c17eda2f4..98526f32dce 100644 --- a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json @@ -3175,13 +3175,13 @@ "target": "com.amazonaws.ecs#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging your Amazon ECS\n\t\t\t\tresources in the Amazon Elastic Container Service Developer Guide.
\nWhen you use Amazon ECS managed tags, you need to set the propagateTags\n\t\t\trequest parameter.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
" + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags aren't propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\nThe default is NONE.
Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more information,\n\t\t\tsee DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and services\n\t\tthat reference a DELETE_IN_PROGRESS task definition revision continue to run\n\t\twithout disruption. Existing services that reference a DELETE_IN_PROGRESS task\n\t\tdefinition revision can still scale up or down by modifying the service's desired\n\t\tcount.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks\n\t\t\tor create new services. You also can't update an existing service to reference a\n\t\t\tDELETE_IN_PROGRESS task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until\n\t\t\tall the associated tasks and services have been terminated.
Deletes one or more task definitions.
\nYou must deregister a task definition revision before you delete it. For more information,\n\t\t\tsee DeregisterTaskDefinition.
\nWhen you delete a task definition revision, it is immediately transitions from the\n\t\tINACTIVE to DELETE_IN_PROGRESS. Existing tasks and services\n\t\tthat reference a DELETE_IN_PROGRESS task definition revision continue to run\n\t\twithout disruption. Existing services that reference a DELETE_IN_PROGRESS task\n\t\tdefinition revision can still scale up or down by modifying the service's desired\n\t\tcount.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks\n\t\t\tor create new services. You also can't update an existing service to reference a\n\t\t\tDELETE_IN_PROGRESS task definition revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until\n\t\t\tall the associated tasks and services have been terminated.
When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.
Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.
\nIf multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Creates an EFS access point. An access point is an application-specific view into an EFS\n file system that applies an operating system user and group, and a file system path, to any\n file system request made through the access point. The operating system user and group\n override any identity information provided by the NFS client. The file system path is exposed\n as the access point's root directory. Applications using the access point can only access data in\n the application's own directory and any subdirectories. To learn more, see Mounting a file system using EFS access\n points.
\nIf multiple requests to create access points on the same file system are sent in quick\n succession, and the file system is near the limit of 1,000 access points, you may experience\n a throttling response for these requests. This is to ensure that the file system does not\n exceed the stated access point limit.
\nThis operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
Access points can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting\n permissions to tag resources during creation.
Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:
\nCreates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state creating.
Returns with the description of the created file system.
\nOtherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation\n token.
\n The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.
For more information, see \n Creating a file system\n in the Amazon EFS User Guide.
\nThe CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.
This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.
You can set the throughput mode for the file system using the ThroughputMode parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.
Creates a new, empty file system. The operation requires a creation token in the\n request that Amazon EFS uses to ensure idempotent creation (calling the operation with same\n creation token has no effect). If a file system does not currently exist that is owned by the\n caller's Amazon Web Services account with the specified creation token, this operation does the\n following:
\nCreates a new, empty file system. The file system will have an Amazon EFS assigned\n ID, and an initial lifecycle state creating.
Returns with the description of the created file system.
\nOtherwise, this operation returns a FileSystemAlreadyExists error with the\n ID of the existing file system.
For basic use cases, you can use a randomly generated UUID for the creation\n token.
\n The idempotent operation allows you to retry a CreateFileSystem call without\n risk of creating an extra file system. This can happen when an initial call fails in a way\n that leaves it uncertain whether or not a file system was actually created. An example might\n be that a transport level timeout occurred or your connection was reset. As long as you use\n the same creation token, if the initial call had succeeded in creating a file system, the\n client can learn of its existence from the FileSystemAlreadyExists error.
For more information, see \n Creating a file system\n in the Amazon EFS User Guide.
\nThe CreateFileSystem call returns while the file system's lifecycle\n state is still creating. You can check the file system creation status by\n calling the DescribeFileSystems operation, which among other things returns the file\n system state.
This operation accepts an optional PerformanceMode parameter that you\n choose for your file system. We recommend generalPurpose performance mode for\n most file systems. File systems using the maxIO performance mode can scale to\n higher levels of aggregate throughput and operations per second with a tradeoff of slightly\n higher latencies for most file operations. The performance mode can't be changed after\n the file system has been created. For more information, see Amazon EFS performance\n modes.
You can set the throughput mode for the file system using the ThroughputMode parameter.
After the file system is fully created, Amazon EFS sets its lifecycle state to\n available, at which point you can create one or more mount targets for the file\n system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in\n your VPC by using the mount target. For more information, see Amazon EFS: How it Works.
This operation requires permissions for the\n elasticfilesystem:CreateFileSystem action.
File systems can be tagged on creation. If tags are specified in the creation action, IAM\n performs additional authorization on the elasticfilesystem:TagResource action to\n verify if users have permissions to create tags. Therefore, you must grant explicit\n permissions to use the elasticfilesystem:TagResource action. For more\n information, see Granting permissions to tag resources during creation.
Describes the status of the destination Amazon EFS file system. If the status is\n ERROR, the destination file system in the replication configuration is in a\n failed state and is unrecoverable. To access the file system data, restore a backup of the\n failed file system to a new file system.
Describes the status of the destination Amazon EFS file system.
\nThe Paused state occurs as a result of opting out of the source or\n destination Region after the replication configuration was created. To resume replication\n for the file system, you need to again opt in to the Amazon Web Services Region. For more\n information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference\n Guide.
The Error state occurs when either the source or the destination file\n system (or both) is in a failed state and is unrecoverable. For more information, see\n Monitoring\n replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then\n restore the most recent backup of the failed file system (either the source or the\n destination) to a new file system.
Amazon EMR on EKS provides a deployment option for Amazon EMR that allows\n you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS).\n With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications.\n For more information about Amazon EMR on EKS concepts and tasks, see What is\n shared id=\"EMR-EKS\"/>.
\n\n Amazon EMR containers is the API name for Amazon EMR on EKS.\n The emr-containers prefix is used in the following scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example,\n aws emr-containers start-job-run.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For\n example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more\n information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example,\n emr-containers.us-east-2.amazonaws.com. For more information, see\n Amazon EMR on EKSService Endpoints.
Amazon EMR on EKS provides a deployment option for Amazon EMR that allows\n you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS).\n With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications.\n For more information about Amazon EMR on EKS concepts and tasks, see What is\n shared id=\"EMR-EKS\"/>.
\n\n Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following\n scenarios:
It is the prefix in the CLI commands for Amazon EMR on EKS. For example,\n aws emr-containers start-job-run.
It is the prefix before IAM policy actions for Amazon EMR on EKS. For\n example, \"Action\": [ \"emr-containers:StartJobRun\"]. For more\n information, see Policy actions for Amazon EMR on EKS.
It is the prefix used in Amazon EMR on EKS service endpoints. For example,\n emr-containers.us-east-2.amazonaws.com. For more information, see\n Amazon EMR on EKSService Endpoints.
The information about the container used for a job run or a managed endpoint.
" } }, + "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration": { + "type": "structure", + "members": { + "rotationSize": { + "target": "com.amazonaws.emrcontainers#RotationSize", + "traits": { + "smithy.api#documentation": "The file size at which to rotate logs. Minimum of 2KB, Maximum of 2GB.
", + "smithy.api#required": {} + } + }, + "maxFilesToKeep": { + "target": "com.amazonaws.emrcontainers#MaxFilesToKeep", + "traits": { + "smithy.api#documentation": "The number of files to keep in container after rotation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for container log rotation.
" + } + }, "com.amazonaws.emrcontainers#ContainerProvider": { "type": "structure", "members": { "type": { "target": "com.amazonaws.emrcontainers#ContainerProviderType", "traits": { - "smithy.api#documentation": "The type of the container provider. Amazon EKS is the only supported type as of now.
", + "smithy.api#documentation": "The type of the container provider. Amazon EKS is the only supported type as of\n now.
", "smithy.api#required": {} } }, @@ -1418,7 +1440,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to\n Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual\n cluster.
", + "smithy.api#documentation": "Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.
", "smithy.api#http": { "method": "POST", "uri": "/virtualclusters/{virtualClusterId}/endpoints", @@ -1723,7 +1745,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to\n Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual\n cluster.
", + "smithy.api#documentation": "Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can\n communicate with your virtual cluster.
", "smithy.api#http": { "method": "DELETE", "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", @@ -1974,7 +1996,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays detailed information about a managed endpoint. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with\n your virtual cluster.
", + "smithy.api#documentation": "Displays detailed information about a managed endpoint. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
", "smithy.api#http": { "method": "GET", "uri": "/virtualclusters/{virtualClusterId}/endpoints/{id}", @@ -2836,7 +2858,7 @@ "min": 3, "max": 2048 }, - "smithy.api#pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:([a-zA-Z0-9]+-?)+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" + "smithy.api#pattern": "^(arn:(aws[a-zA-Z0-9-]*):kms:.+:(\\d{12})?:key\\/[(0-9a-zA-Z)-?]+|\\$\\{[a-zA-Z]\\w*\\})$" } }, "com.amazonaws.emrcontainers#KubernetesNamespace": { @@ -3062,7 +3084,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with\n your virtual cluster.
", + "smithy.api#documentation": "Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway\n that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
", "smithy.api#http": { "method": "GET", "uri": "/virtualclusters/{virtualClusterId}/endpoints", @@ -3256,7 +3278,7 @@ "containerProviderType": { "target": "com.amazonaws.emrcontainers#ContainerProviderType", "traits": { - "smithy.api#documentation": "The container provider type of the virtual cluster. Amazon EKS is the only supported type as of\n now.
", + "smithy.api#documentation": "The container provider type of the virtual cluster. Amazon EKS is the only\n supported type as of now.
", "smithy.api#httpQuery": "containerProviderType" } }, @@ -3340,6 +3362,15 @@ "smithy.api#pattern": "^[\\.\\-_/#A-Za-z0-9]+$" } }, + "com.amazonaws.emrcontainers#MaxFilesToKeep": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.emrcontainers#MonitoringConfiguration": { "type": "structure", "members": { @@ -3360,6 +3391,12 @@ "traits": { "smithy.api#documentation": "Amazon S3 configuration for monitoring log publishing.
" } + }, + "containerLogRotationConfiguration": { + "target": "com.amazonaws.emrcontainers#ContainerLogRotationConfiguration", + "traits": { + "smithy.api#documentation": "Enable or disable container log rotation.
" + } } }, "traits": { @@ -3589,6 +3626,16 @@ "smithy.api#documentation": "The current status of the retry policy executed on the job.
" } }, + "com.amazonaws.emrcontainers#RotationSize": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 12 + }, + "smithy.api#pattern": "^\\d+(\\.\\d+)?[KMG][Bb]?$" + } + }, "com.amazonaws.emrcontainers#RsiArn": { "type": "string", "traits": { @@ -3940,7 +3987,7 @@ } ], "traits": { - "smithy.api#documentation": "Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag\n consists of a key and an optional value, both of which you define. Tags enable you to\n categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When\n you have many resources of the same type, you can quickly identify a specific resource\n based on the tags you've assigned to it. For example, you can define a set of tags for your\n Amazon EMR on EKS clusters to help you track each cluster's owner and stack level.\n We recommend that you devise a consistent set of tag keys for each resource type. You can\n then search and filter the resources based on the tags that you add.
", + "smithy.api#documentation": "Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services\n resource. Each tag consists of a key and an optional value, both of which you define. Tags\n enable you to categorize your Amazon Web Services resources by attributes such as purpose,\n owner, or environment. When you have many resources of the same type, you can quickly\n identify a specific resource based on the tags you've assigned to it. For example, you can\n define a set of tags for your Amazon EMR on EKS clusters to help you track each\n cluster's owner and stack level. We recommend that you devise a consistent set of tag keys\n for each resource type. You can then search and filter the resources based on the tags that\n you add.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -4204,7 +4251,7 @@ } }, "traits": { - "smithy.api#documentation": "This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace\n that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host\n endpoints. Multiple virtual clusters can be backed by the same physical cluster. However,\n each virtual cluster maps to one namespace on an Amazon EKS cluster. Virtual clusters do not\n create any active resources that contribute to your bill or that require lifecycle\n management outside the service.
" + "smithy.api#documentation": "This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace\n that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run\n jobs and host endpoints. Multiple virtual clusters can be backed by the same physical\n cluster. However, each virtual cluster maps to one namespace on an Amazon EKS\n cluster. Virtual clusters do not create any active resources that contribute to your bill\n or that require lifecycle management outside the service.
" } }, "com.amazonaws.emrcontainers#VirtualClusterArn": { diff --git a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json index e5932d0678c..634bd7ef827 100644 --- a/codegen/sdk-codegen/aws-models/emr.2009-03-31.json +++ b/codegen/sdk-codegen/aws-models/emr.2009-03-31.json @@ -8897,6 +8897,24 @@ "traits": { "smithy.api#enumValue": "capacity-optimized" } + }, + "PRICE_CAPACITY_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "price-capacity-optimized" + } + }, + "LOWEST_PRICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "lowest-price" + } + }, + "DIVERSIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "diversified" + } } } }, @@ -8926,7 +8944,7 @@ "AllocationStrategy": { "target": "com.amazonaws.emr#SpotProvisioningAllocationStrategy", "traits": { - "smithy.api#documentation": "Specifies the strategy to use in launching Spot Instance fleets. Currently, the only\n option is capacity-optimized (the default), which launches instances from Spot Instance\n pools with optimal capacity for the number of instances that are launching.
" + "smithy.api#documentation": "Specifies one of the following strategies to launch Spot Instance fleets: price-capacity-optimized, capacity-optimized, lowest-price, or diversified. For more information on the provisioning strategies, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide for Linux Instances.
When you launch a Spot Instance fleet with the old console, it automatically launches with the capacity-optimized strategy. You can't change the allocation strategy from the old console.
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\n for all file systems except for Scratch_1 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.
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\n on all FSx for Lustre 2.12 and newer file systems, excluding\n scratch_1 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.
Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available, except US West (Oregon).
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", + "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MBps.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available, except US West (Oregon).
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MBps\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", "smithy.api#required": {} } }, "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
\nFor SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
For SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
You pay for additional throughput capacity that you provision.
", + "smithy.api#documentation": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:
\nFor SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
For SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
You pay for additional throughput capacity that you provision.
", "smithy.api#required": {} } }, @@ -3717,7 +3717,7 @@ "com.amazonaws.fsx#DNSName": { "type": "string", "traits": { - "smithy.api#documentation": "The Domain Name Service (DNS) name for the file system. You can mount your file\n system using its DNS name.
", + "smithy.api#documentation": "The file system's DNS name. You can mount your file\n system using its DNS name.
", "smithy.api#length": { "min": 16, "max": 275 @@ -3839,7 +3839,7 @@ } }, "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 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 on Amazon File Cache resources and\n all Amazon FSx for Lustre file systems excluding Scratch_1 deployment\n types.
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 on Amazon File Cache resources and\n all FSx for Lustre 2.12 and newer file systems, excluding\n scratch_1 deployment type.
Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported for all file systems except for Scratch_1\n deployment type.
Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported on all FSx for Lustre 2.12 and newer file\n systems, excluding scratch_1 deployment type.
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 on Amazon File Cache resources and all Amazon FSx for\n Lustre file systems excluding Scratch_1 deployment types.
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.
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 on Amazon File Cache resources and all FSx for Lustre\n 2.12 and newer file systems, excluding scratch_1 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 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.
Specifies whether the number of IOPS for the file system is\n using the system default (AUTOMATIC) or was\n provisioned by the customer (USER_PROVISIONED).
Specifies whether the file system is \n using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, , or \n if it using a USER_PROVISIONED value.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The\n default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how the amount was provisioned (by the customer or by the system).
" + "smithy.api#documentation": "The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or FSx for OpenZFS file system. By default, Amazon FSx \n automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per\n GB of storage. The configuration consists of the total number of provisioned SSD IOPS\n and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
" } }, "com.amazonaws.fsx#DiskIopsConfigurationMode": { @@ -7773,6 +7776,12 @@ }, "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime" + }, + "FsxAdminPassword": { + "target": "com.amazonaws.fsx#AdminPassword", + "traits": { + "smithy.api#documentation": "You can use the fsxadmin user account to access the NetApp ONTAP CLI and \n REST API. The password value is always redacted in the response.
The current percent of progress of an asynchronous task.
", + "smithy.api#documentation": "Displays the current percent of progress of an asynchronous task.
", "smithy.api#range": { "min": 0, "max": 100 @@ -8796,7 +8805,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an ONTAP storage virtual machine (SVM) to\n a self-managed (including on-premises) Microsoft Active Directory (AD)\n directory. For more information, see \n \n Using Amazon FSx with your self-managed Microsoft Active Directory or \n Managing SVMs.
" + "smithy.api#documentation": "The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to\n a self-managed (including on-premises) Microsoft Active Directory (AD)\n directory. For more information, see \n \n Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or \n Managing FSx for ONTAP SVMs.
" } }, "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates": { @@ -8805,24 +8814,42 @@ "UserName": { "target": "com.amazonaws.fsx#DirectoryUserName", "traits": { - "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.
Specifies the updated user name for the service account on your self-managed AD domain.\n Amazon FSx uses this account to join to your self-managed AD domain.
\nThis account must have the permissions required to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName.
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain.
" + "smithy.api#documentation": "Specifies the updated password for the service account on your self-managed AD domain. \n Amazon FSx uses this account to join to your self-managed AD domain.
" } }, "DnsIps": { "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "A list of up to three IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.
" + "smithy.api#documentation": "A list of up to three DNS server or domain controller IP addresses in your\n self-managed AD domain.
" + } + }, + "DomainName": { + "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", + "traits": { + "smithy.api#documentation": "Specifies an updated fully qualified domain name of your self-managed AD configuration.
" + } + }, + "OrganizationalUnitDistinguishedName": { + "target": "com.amazonaws.fsx#OrganizationalUnitDistinguishedName", + "traits": { + "smithy.api#documentation": "Specifies an updated fully qualified distinguished name of the organization unit within your self-managed AD.
" + } + }, + "FileSystemAdministratorsGroup": { + "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", + "traits": { + "smithy.api#documentation": "Specifies the updated name of the self-managed AD domain group whose members are granted administrative privileges\n for the Amazon FSx resource.
" } } }, "traits": { - "smithy.api#documentation": "The configuration that Amazon FSx uses to join the Windows File Server instance to a\n self-managed Microsoft Active Directory (AD) directory.
" + "smithy.api#documentation": "Specifies changes you are making to the self-managed Microsoft Active Directory (AD) configuration to which \n an FSx for Windows File Server file system or an FSx for ONTAP SVM is joined.
" } }, "com.amazonaws.fsx#ServiceLimit": { @@ -9193,7 +9220,7 @@ "com.amazonaws.fsx#StorageCapacity": { "type": "integer", "traits": { - "smithy.api#documentation": "The storage capacity for your Amazon FSx file system, in gibibytes.
", + "smithy.api#documentation": "Specifies the file system's storage capacity, in gibibytes (GiB).
", "smithy.api#range": { "min": 0, "max": 2147483647 @@ -9217,7 +9244,7 @@ } }, "traits": { - "smithy.api#documentation": "The storage type for your Amazon FSx file system.
" + "smithy.api#documentation": "Specifies the file system's storage type.
" } }, "com.amazonaws.fsx#StorageVirtualMachine": { @@ -9553,7 +9580,7 @@ "NetBiosName": { "target": "com.amazonaws.fsx#NetBiosAlias", "traits": { - "smithy.api#documentation": "The NetBIOS name of the Active Directory computer object that is joined to your SVM.
" + "smithy.api#documentation": "The NetBIOS name of the AD computer object to which the SVM is joined.
" } }, "SelfManagedActiveDirectoryConfiguration": { @@ -9561,7 +9588,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the configuration of the Microsoft Active Directory (AD) \n directory to which the Amazon FSx for ONTAP storage virtual machine (SVM) is joined.\n Pleae note, account credentials are not returned in the response payload.
" + "smithy.api#documentation": "Describes the Microsoft Active Directory (AD) directory configuration to which the FSx for ONTAP storage virtual machine (SVM) is joined.\n Note that account credentials are not returned in the response payload.
" } }, "com.amazonaws.fsx#SvmEndpoint": { @@ -9927,7 +9954,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations\n are supported for all file systems except for Scratch_1\n deployment type.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations\n are supported on all FSx for Lustre 2.12 and newer file systems,\n excluding scratch_1 deployment type.
The ONTAP administrative password for the fsxadmin user.
Update the password for the fsxadmin user by entering a new password. \n You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. \n For more information, see \n Managing resources using NetApp Applicaton.
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity,\n but you can provision additional IOPS per GB of storage. The configuration consists\n of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in\n the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned.
The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity,\n but you can provision additional IOPS per GB of storage. The configuration consists\n of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in\n the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. \n For more information, see \n Updating SSD storage capacity and IOPS.
Specifies the throughput of an FSx for NetApp ONTAP file system, measured in megabytes per second\n (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
" + "smithy.api#documentation": "Enter a new value to change the amount of throughput capacity for the file system. Throughput capacity is measured in megabytes per second\n (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps. For more information, see \n Managing throughput capacity \n in the FSx for ONTAP User Guide.
" } }, "AddRouteTableIds": { @@ -10253,7 +10280,7 @@ "StorageCapacity": { "target": "com.amazonaws.fsx#StorageCapacity", "traits": { - "smithy.api#documentation": "Use this parameter to increase the storage capacity of an FSx for Windows File Server,\n FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.\n Specifies the storage capacity target value, in GiB, to increase the storage capacity for\n the file system that you're updating.
\nYou can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput\n capacity in the FSx for Lustre User Guide.
\nFor FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity in the FSx for OpenZFS User\n Guide.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSx for Windows File Server User\n Guide.
\nFor ONTAP file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
" + "smithy.api#documentation": "Use this parameter to increase the storage capacity of an FSx for Windows File Server,\n FSx for Lustre, FSx for OpenZFS, or FSx for ONTAP file system.\n Specifies the storage capacity target value, in GiB, to increase the storage capacity for\n the file system that you're updating.
\nYou can't make a storage capacity increase request if there is an existing storage\n capacity increase request in progress.
\nFor Lustre file systems, the storage capacity target value can be the following:
\nFor SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values\n are in multiples of 2400 GiB. The value must be greater than the current storage capacity.
For PERSISTENT HDD file systems, valid values are multiples of 6000 GiB for\n 12-MBps throughput per TiB file systems and multiples of 1800 GiB for 40-MBps throughput\n per TiB file systems. The values must be greater than the current storage capacity.
For SCRATCH_1 file systems, you can't increase the storage capacity.
For more information, see Managing storage and throughput\n capacity in the FSx for Lustre User Guide.
\nFor FSx for OpenZFS file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity in the FSx for OpenZFS User\n Guide.
\nFor Windows file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. To increase storage capacity, the file system\n must have at least 16 MBps of throughput capacity. For more information, see Managing storage\n capacity in the Amazon FSxfor Windows File Server User\n Guide.
\nFor ONTAP file systems, the storage capacity target value must be at least 10 percent\n greater than the current storage capacity value. For more information, see\n Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User\n Guide.
" } }, "WindowsConfiguration": { @@ -10271,7 +10298,7 @@ "OpenZFSConfiguration": { "target": "com.amazonaws.fsx#UpdateFileSystemOpenZFSConfiguration", "traits": { - "smithy.api#documentation": "The configuration updates for an Amazon FSx for OpenZFS file system.
" + "smithy.api#documentation": "The configuration updates for an FSx for OpenZFS file system.
" } } }, @@ -10531,7 +10558,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
" + "smithy.api#documentation": "Updates an FSx for ONTAP storage virtual machine (SVM).
" } }, "com.amazonaws.fsx#UpdateStorageVirtualMachineRequest": { @@ -10540,7 +10567,7 @@ "ActiveDirectoryConfiguration": { "target": "com.amazonaws.fsx#UpdateSvmActiveDirectoryConfiguration", "traits": { - "smithy.api#documentation": "Updates the Microsoft Active Directory (AD) configuration for an SVM that is joined to an AD.
" + "smithy.api#documentation": "Specifies updates to an SVM's Microsoft Active Directory (AD) configuration.
" } }, "ClientRequestToken": { @@ -10559,7 +10586,7 @@ "SvmAdminPassword": { "target": "com.amazonaws.fsx#AdminPassword", "traits": { - "smithy.api#documentation": "Enter a new SvmAdminPassword if you are updating it.
" + "smithy.api#documentation": "Specifies a new SvmAdminPassword.
" } } }, @@ -10583,10 +10610,16 @@ "members": { "SelfManagedActiveDirectoryConfiguration": { "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates" + }, + "NetBiosName": { + "target": "com.amazonaws.fsx#NetBiosAlias", + "traits": { + "smithy.api#documentation": "Specifies an updated NetBIOS name of the AD computer object NetBiosName to which an SVM is joined.
Updates the Microsoft Active Directory (AD) configuration of an SVM joined to an AD. \n Please note, account credentials are not returned in the response payload.
" + "smithy.api#documentation": "Specifies updates to an FSx for ONTAP storage virtual machine's (SVM) Microsoft Active Directory (AD) configuration. \n Note that account credentials are not returned in the response payload.
" } }, "com.amazonaws.fsx#UpdateVolume": { diff --git a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json index 02d5c2708f7..70747ef8865 100644 --- a/codegen/sdk-codegen/aws-models/glue.2017-03-31.json +++ b/codegen/sdk-codegen/aws-models/glue.2017-03-31.json @@ -10514,6 +10514,12 @@ "traits": { "smithy.api#documentation": "The name of the catalog database.
" } + }, + "Region": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Region of the target database.
" + } } }, "traits": { @@ -30742,6 +30748,12 @@ "traits": { "smithy.api#documentation": "The name of the target table.
" } + }, + "Region": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#documentation": "Region of the target table.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json index 7b0205f4cee..e3faf72bfb2 100644 --- a/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json +++ b/codegen/sdk-codegen/aws-models/guardduty.2017-11-28.json @@ -1790,7 +1790,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nWhen using Create Members as an organizations delegated administrator this\n action will enable GuardDuty in the added member accounts, with the exception of the\n organization delegated administrator account, which must enable GuardDuty prior to being added\n as a member.
If you are adding accounts by invitation, use this action after GuardDuty has bee enabled in\n potential member accounts and before using InviteMembers.
", + "smithy.api#documentation": "Creates member accounts of the current Amazon Web Services account by specifying a list of Amazon Web Services account\n IDs. This step is a prerequisite for managing the associated member accounts either by\n invitation or through an organization.
\nAs a delegated administrator, using CreateMembers will enable GuardDuty in \n the added member accounts, with the exception of the\n organization delegated administrator account. A delegated administrator must enable GuardDuty \n prior to being added as a member.
If you are adding accounts by invitation, before using InviteMembers, use \n CreateMembers after GuardDuty has been enabled in potential member accounts.
If you disassociate a member from a GuardDuty \n delegated administrator, the member account details \n obtained from this API, including the associated email addresses, will be retained. \n This is done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member", @@ -3606,7 +3606,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disable GuardDuty in a member\n account.
Disassociates the current GuardDuty member account from its administrator account.
", + "smithy.api#documentation": "Disassociates the current GuardDuty member account from its administrator account.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/master/disassociate", @@ -3713,7 +3713,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates GuardDuty member accounts (to the current administrator account) specified\n by the account IDs.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.
Disassociates GuardDuty member accounts (from the current administrator account) specified\n by the account IDs.
\nWhen you \n disassociate an invited member from a GuardDuty delegated administrator, the member account details \n obtained from the CreateMembers API, including the associated email addresses, are retained. This is \n done so that the delegated administrator can invoke the InviteMembers API without the need to invoke the CreateMembers API again. To \n remove the details associated with a member account, the delegated administrator must invoke the \n DeleteMembers API.
\nWith autoEnableOrganizationMembers configuration for your organization set to\n ALL, you'll receive an error if you attempt to disassociate a member account\n before removing them from your Amazon Web Services organization.
The domain information for the API request.
", + "smithy.api#documentation": "The domain information for the DNS query.
", "smithy.api#jsonName": "domain" } }, @@ -7538,7 +7538,7 @@ } ], "traits": { - "smithy.api#documentation": "Invites other Amazon Web Services accounts (created as members of the current Amazon Web Services account by\n CreateMembers) to enable GuardDuty, and allow the current Amazon Web Services account to view and manage\n these accounts' findings on their behalf as the GuardDuty administrator account.
", + "smithy.api#documentation": "Invites Amazon Web Services accounts to become members of an organization administered by the Amazon Web Services account \n that invokes this API. If you are using Amazon Web Services Organizations to manager your GuardDuty environment, this step is not \n needed. For more information, see Managing accounts with Amazon Web Services Organizations.
\nTo invite Amazon Web Services accounts, the first step is \n to ensure that GuardDuty has been enabled in the potential member accounts. You can now invoke this API\n to add accounts by invitation. The \n invited accounts can either accept or decline the invitation from their GuardDuty accounts. Each invited Amazon Web Services account can \n choose to accept the invitation from only one Amazon Web Services account. For more information, see \n Managing GuardDuty accounts \n by invitation.
\nAfter the invite has been accepted and you choose to disassociate a member account \n (by using DisassociateMembers) from your account, \n the details of the member account obtained by invoking CreateMembers, including the \n associated email addresses, will be retained. \n This is done so that you can invoke InviteMembers without the need to invoke \n CreateMembers again. To \n remove the details associated with a member account, you must also invoke \n DeleteMembers.
", "smithy.api#http": { "method": "POST", "uri": "/detector/{DetectorId}/member/invite", diff --git a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json index 8453b370fcd..3f222206c62 100644 --- a/codegen/sdk-codegen/aws-models/iam.2010-05-08.json +++ b/codegen/sdk-codegen/aws-models/iam.2010-05-08.json @@ -2576,6 +2576,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, @@ -2587,7 +2590,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account\n alias, see Using an\n alias for your Amazon Web Services account ID in the\n IAM User Guide.
" + "smithy.api#documentation": "Creates an alias for your Amazon Web Services account. For information about using an Amazon Web Services account\n alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.
" } }, "com.amazonaws.iam#CreateAccountAliasRequest": { @@ -3574,6 +3577,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#EntityTemporarilyUnmodifiableException" }, @@ -3666,6 +3672,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#LimitExceededException" }, @@ -3677,7 +3686,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services\n account alias, see Using an alias for your Amazon Web Services account ID in the\n IAM User Guide.
" + "smithy.api#documentation": "Deletes the specified Amazon Web Services account alias. For information about using an Amazon Web Services\n account alias, see Creating, deleting, and\n listing an Amazon Web Services account alias in the Amazon Web Services Sign-In User\n Guide.
" } }, "com.amazonaws.iam#DeleteAccountAliasRequest": { @@ -4390,6 +4399,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#LimitExceededException" }, @@ -4558,6 +4570,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#DeleteConflictException" }, @@ -4838,6 +4853,9 @@ "target": "smithy.api#Unit" }, "errors": [ + { + "target": "com.amazonaws.iam#ConcurrentModificationException" + }, { "target": "com.amazonaws.iam#EntityAlreadyExistsException" }, @@ -7364,7 +7382,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the account alias associated with the Amazon Web Services account (Note: you can have only\n one). For information about using an Amazon Web Services account alias, see Using an alias for your\n Amazon Web Services account ID in the IAM User Guide.
", + "smithy.api#documentation": "Lists the account alias associated with the Amazon Web Services account (Note: you can have only\n one). For information about using an Amazon Web Services account alias, see Creating,\n deleting, and listing an Amazon Web Services account alias in the Amazon Web Services Sign-In\n User Guide.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -9083,7 +9101,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the IAM roles that have the specified path prefix. If there are none, the\n operation returns an empty list. For more information about roles, see Working with\n roles.
\nIAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a role, see GetRole.
\nYou can paginate the results using the MaxItems and Marker\n parameters.
Lists the IAM roles that have the specified path prefix. If there are none, the\n operation returns an empty list. For more information about roles, see Working with\n roles.
\nIAM resource-listing operations return a subset of the available \n attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
\nPermissionsBoundary
\nRoleLastUsed
\nTags
\nTo view all of the information for a role, see GetRole.
\nYou can paginate the results using the MaxItems and Marker\n parameters.
Lists the IAM users that have the specified path prefix. If no path prefix is\n specified, the operation returns all users in the Amazon Web Services account. If there are none, the\n operation returns an empty list.
\nIAM resource-listing operations return a subset of the available \n attributes for the resource. For example, this operation does not return tags, even though they are an attribute of the returned object. To view all of the information for a user, see GetUser.
\nYou can paginate the results using the MaxItems and Marker\n parameters.
Lists the IAM users that have the specified path prefix. If no path prefix is\n specified, the operation returns all users in the Amazon Web Services account. If there are none, the\n operation returns an empty list.
\nIAM resource-listing operations return a subset of the available \n attributes for the resource. This operation does not return the following attributes, even though they are an attribute of the returned object:
\nPermissionsBoundary
\nTags
\nTo view all of the information for a user, see GetUser.
\nYou can paginate the results using the MaxItems and Marker\n parameters.
The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded.
The base32 seed defined as specified in RFC3548. The Base32StringSeed is base32-encoded.
Contains parameter details for each of the parameters that the component document\n\t\t\tdefined for the component.
" + "smithy.api#documentation": "Contains parameter details for each of the parameters that the component document \n\t\t\tdefined for the component.
" } }, "owner": { @@ -449,14 +449,14 @@ "publisher": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "Contains the name of the publisher if this is a third-party component. Otherwise, this\n\t\t\tproperty is empty.
" + "smithy.api#documentation": "Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.
" } }, "obfuscate": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether component source is hidden from view in the console, and from\n\t\t\tcomponent detail results for API, CLI, or SDK operations.
" + "smithy.api#documentation": "Indicates whether component source is hidden from view in the console, and from \n\t\t\tcomponent detail results for API, CLI, or SDK operations.
" } } }, @@ -743,14 +743,14 @@ "publisher": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "Contains the name of the publisher if this is a third-party component. Otherwise, this\n\t\t\tproperty is empty.
" + "smithy.api#documentation": "Contains the name of the publisher if this is a third-party component. Otherwise, \n\t\t\tthis property is empty.
" } }, "obfuscate": { "target": "com.amazonaws.imagebuilder#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether component source is hidden from view in the console, and from\n\t\t\tcomponent detail results for API, CLI, or SDK operations.
" + "smithy.api#documentation": "Indicates whether component source is hidden from view in the console, \n\t\t\tand from component detail results for API, CLI, or SDK operations.
" } } }, @@ -4561,13 +4561,13 @@ "enhancedImageMetadataEnabled": { "target": "com.amazonaws.imagebuilder#NullableBoolean", "traits": { - "smithy.api#documentation": "Indicates whether Image Builder collects additional information about the image, such as the\n\t\t\toperating system (OS) version and package list.
" + "smithy.api#documentation": "Indicates whether Image Builder collects additional information about the image, such as \n\t\t\tthe operating system (OS) version and package list.
" } }, "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { - "smithy.api#documentation": "The operating system version for instances that launch from this image. For example,\n\t\t\tAmazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" + "smithy.api#documentation": "The operating system version for instances that launch from this image. For example, \n\t\t\tAmazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" } }, "state": { @@ -4579,13 +4579,13 @@ "imageRecipe": { "target": "com.amazonaws.imagebuilder#ImageRecipe", "traits": { - "smithy.api#documentation": "For images that distribute an AMI, this is the image recipe that Image Builder used to create\n\t\t\tthe image. For container images, this is empty.
" + "smithy.api#documentation": "For images that distribute an AMI, this is the image recipe that Image Builder used to \n\t\t\tcreate the image. For container images, this is empty.
" } }, "containerRecipe": { "target": "com.amazonaws.imagebuilder#ContainerRecipe", "traits": { - "smithy.api#documentation": "For container images, this is the container recipe that Image Builder used to create the image.\n\t\t\tFor images that distribute an AMI, this is empty.
" + "smithy.api#documentation": "For container images, this is the container recipe that Image Builder used to create the \n\t\t\timage. For images that distribute an AMI, this is empty.
" } }, "sourcePipelineName": { @@ -4828,7 +4828,7 @@ "dateNextRun": { "target": "com.amazonaws.imagebuilder#DateTime", "traits": { - "smithy.api#documentation": "This is no longer supported, and does not return a value.
" + "smithy.api#documentation": "The next date when the pipeline is scheduled to run.
" } }, "tags": { @@ -5463,7 +5463,7 @@ "osVersion": { "target": "com.amazonaws.imagebuilder#OsVersion", "traits": { - "smithy.api#documentation": "The operating system version of the instances that launch from this image. For\n\t\t\texample, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" + "smithy.api#documentation": "The operating system version of the instances that launch from this image. For \n\t\t\texample, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.
" } }, "state": { @@ -5595,7 +5595,7 @@ "platform": { "target": "com.amazonaws.imagebuilder#Platform", "traits": { - "smithy.api#documentation": "The operating system platform of the image version, for example \"Windows\" or\n\t\t\t\"Linux\".
" + "smithy.api#documentation": "The operating system platform of the image version, for example \"Windows\" or \n\t\t\t\"Linux\".
" } }, "osVersion": { diff --git a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json index 89acdb308b1..ac165586d3e 100644 --- a/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json +++ b/codegen/sdk-codegen/aws-models/inspector2.2020-06-08.json @@ -1443,6 +1443,38 @@ } } }, + "com.amazonaws.inspector2#CoverageDateFilter": { + "type": "structure", + "members": { + "startInclusive": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "A timestamp representing the start of the time period to filter results by.
" + } + }, + "endInclusive": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "A timestamp representing the end of the time period to filter results by.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details of a coverage date filter.
" + } + }, + "com.amazonaws.inspector2#CoverageDateFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.inspector2#CoverageDateFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.inspector2#CoverageFilterCriteria": { "type": "structure", "members": { @@ -1473,7 +1505,7 @@ "resourceType": { "target": "com.amazonaws.inspector2#CoverageStringFilterList", "traits": { - "smithy.api#documentation": "An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE or AWS_ECR_REPOSITORY.
An array of Amazon Web Services resource types to return coverage statistics for. The values can be AWS_EC2_INSTANCE, AWS_LAMBDA_FUNCTION or AWS_ECR_REPOSITORY.
Returns coverage statistics for AWS Lambda functions filtered by runtime.
" } + }, + "lastScannedAt": { + "target": "com.amazonaws.inspector2#CoverageDateFilterList", + "traits": { + "smithy.api#documentation": "Filters Amazon Web Services resources based on whether Amazon Inspector has checked them for vulnerabilities within the specified time range.
" + } } }, "traits": { @@ -1697,6 +1735,12 @@ "traits": { "smithy.api#documentation": "An object that contains details about the metadata.
" } + }, + "lastScannedAt": { + "target": "com.amazonaws.inspector2#DateTimeTimestamp", + "traits": { + "smithy.api#documentation": "The date and time the resource was last checked for vulnerabilities.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json b/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json index 71017a74a56..f6001924858 100644 --- a/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json +++ b/codegen/sdk-codegen/aws-models/iot-data-plane.2015-05-28.json @@ -976,8 +976,8 @@ }, "params": { "Region": "ap-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -989,8 +989,8 @@ }, "params": { "Region": "ap-northeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1002,8 +1002,8 @@ }, "params": { "Region": "ap-northeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1015,8 +1015,8 @@ }, "params": { "Region": "ap-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1028,8 +1028,8 @@ }, "params": { "Region": "ap-southeast-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1041,8 +1041,8 @@ }, "params": { "Region": "ap-southeast-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1054,8 +1054,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1067,8 +1067,8 @@ }, "params": { "Region": "ca-central-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1080,8 +1080,8 @@ }, "params": { "Region": "eu-central-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1093,8 +1093,8 @@ }, "params": { "Region": "eu-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1106,8 +1106,8 @@ }, "params": { "Region": "eu-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1119,8 +1119,8 @@ }, "params": { "Region": "eu-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1132,8 +1132,8 @@ }, "params": { "Region": "eu-west-3", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1145,8 +1145,8 @@ }, "params": { "Region": "me-south-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1158,8 +1158,8 @@ }, "params": { "Region": "sa-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1171,8 +1171,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1184,8 +1184,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1197,8 +1197,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1210,8 +1210,8 @@ }, "params": { "Region": "us-east-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1223,8 +1223,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1236,8 +1236,8 @@ }, "params": { "Region": "us-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1249,8 +1249,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1262,8 +1262,8 @@ }, "params": { "Region": "us-west-2", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1275,8 +1275,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1288,8 +1288,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1301,8 +1301,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1314,8 +1314,8 @@ }, "params": { "Region": "cn-northwest-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1327,8 +1327,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1340,8 +1340,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1353,8 +1353,8 @@ }, "params": { "Region": "cn-north-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1366,8 +1366,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1379,8 +1379,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1392,8 +1392,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1405,8 +1405,8 @@ }, "params": { "Region": "us-gov-west-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1418,8 +1418,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1431,8 +1431,8 @@ }, "params": { "Region": "us-gov-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1442,8 +1442,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1455,8 +1455,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1466,8 +1466,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1479,8 +1479,8 @@ }, "params": { "Region": "us-iso-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1490,8 +1490,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": true } }, { @@ -1503,8 +1503,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": true + "UseFIPS": true, + "UseDualStack": false } }, { @@ -1514,8 +1514,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": true, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": true } }, { @@ -1527,8 +1527,8 @@ }, "params": { "Region": "us-isob-east-1", - "UseDualStack": false, - "UseFIPS": false + "UseFIPS": false, + "UseDualStack": false } }, { @@ -1540,8 +1540,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1553,8 +1553,8 @@ } }, "params": { - "UseDualStack": false, "UseFIPS": false, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1565,8 +1565,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": false, "UseFIPS": true, + "UseDualStack": false, "Endpoint": "https://example.com" } }, @@ -1577,8 +1577,8 @@ }, "params": { "Region": "us-east-1", - "UseDualStack": true, "UseFIPS": false, + "UseDualStack": true, "Endpoint": "https://example.com" } }, @@ -2087,7 +2087,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + "smithy.api#pattern": "^[$a-zA-Z0-9:_-]+$" } }, "com.amazonaws.iotdataplane#SynthesizedJsonUserProperties": { diff --git a/codegen/sdk-codegen/aws-models/iot.2015-05-28.json b/codegen/sdk-codegen/aws-models/iot.2015-05-28.json index 9214ce1316c..23016447971 100644 --- a/codegen/sdk-codegen/aws-models/iot.2015-05-28.json +++ b/codegen/sdk-codegen/aws-models/iot.2015-05-28.json @@ -123,6 +123,12 @@ { "target": "com.amazonaws.iot#CreateOTAUpdate" }, + { + "target": "com.amazonaws.iot#CreatePackage" + }, + { + "target": "com.amazonaws.iot#CreatePackageVersion" + }, { "target": "com.amazonaws.iot#CreatePolicy" }, @@ -213,6 +219,12 @@ { "target": "com.amazonaws.iot#DeleteOTAUpdate" }, + { + "target": "com.amazonaws.iot#DeletePackage" + }, + { + "target": "com.amazonaws.iot#DeletePackageVersion" + }, { "target": "com.amazonaws.iot#DeletePolicy" }, @@ -402,6 +414,15 @@ { "target": "com.amazonaws.iot#GetOTAUpdate" }, + { + "target": "com.amazonaws.iot#GetPackage" + }, + { + "target": "com.amazonaws.iot#GetPackageConfiguration" + }, + { + "target": "com.amazonaws.iot#GetPackageVersion" + }, { "target": "com.amazonaws.iot#GetPercentiles" }, @@ -510,6 +531,12 @@ { "target": "com.amazonaws.iot#ListOutgoingCertificates" }, + { + "target": "com.amazonaws.iot#ListPackages" + }, + { + "target": "com.amazonaws.iot#ListPackageVersions" + }, { "target": "com.amazonaws.iot#ListPolicies" }, @@ -717,6 +744,15 @@ { "target": "com.amazonaws.iot#UpdateMitigationAction" }, + { + "target": "com.amazonaws.iot#UpdatePackage" + }, + { + "target": "com.amazonaws.iot#UpdatePackageConfiguration" + }, + { + "target": "com.amazonaws.iot#UpdatePackageVersion" + }, { "target": "com.amazonaws.iot#UpdateProvisioningTemplate" }, @@ -5681,6 +5717,16 @@ "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" } }, + "com.amazonaws.iot#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 64 + }, + "smithy.api#pattern": "^\\S{36,64}$" + } + }, "com.amazonaws.iot#CloudwatchAlarmAction": { "type": "structure", "members": { @@ -6047,6 +6093,12 @@ "members": { "message": { "target": "com.amazonaws.iot#ErrorMessage2" + }, + "resourceId": { + "target": "com.amazonaws.iot#resourceId", + "traits": { + "smithy.api#documentation": "A resource with the same name already exists.
" + } } }, "traits": { @@ -6433,7 +6485,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an X.509 certificate using the specified certificate signing\n request.\n
\nRequires permission to access the CreateCertificateFromCsr action.\n
\nThe CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-25 or NIST P-384 curves. \n For supported certificates, consult \n Certificate signing algorithms supported by IoT.\n
\nReusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs. In the following commands, we assume that a set of CSRs are located inside of the\n directory my-csr-directory:
On Linux and OS X, the command is:
\n\n $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for\n the corresponding CSR.
You can also run the aws iot create-certificate-from-csr part of the\n command in parallel to speed up the certificate creation process:
\n $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n \n
On Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}\n \n
On a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"\n \n
Creates an X.509 certificate using the specified certificate signing\n request.\n
\nRequires permission to access the CreateCertificateFromCsr action.\n
\nThe CSR must include a public key that is either an\n RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. \n For supported certificates, consult \n Certificate signing algorithms supported by IoT.\n
\nReusing the same certificate signing request (CSR)\n results in a distinct certificate.
\nYou can create multiple certificates in a batch by creating a directory, copying\n multiple .csr files into that directory, and then specifying that directory on the command\n line. The following commands show how to create a batch of certificates given a batch of\n CSRs. In the following commands, we assume that a set of CSRs are located inside of the\n directory my-csr-directory:
On Linux and OS X, the command is:
\n\n $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n
This command lists all of the CSRs in my-csr-directory and pipes each CSR file name\n to the aws iot create-certificate-from-csr Amazon Web Services CLI command to create a certificate for\n the corresponding CSR.
You can also run the aws iot create-certificate-from-csr part of the\n command in parallel to speed up the certificate creation process:
\n $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/{}\n \n
On Windows PowerShell, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr\n --certificate-signing-request file://my-csr-directory/$_}\n \n
On a Windows command prompt, the command to create certificates for all CSRs in\n my-csr-directory is:
\n\n > forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr\n --certificate-signing-request file://@path\"\n \n
An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0.
For more information, see Methods for accessing a bucket.
" + "smithy.api#documentation": "An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.
For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0\n
For more information, see Methods for accessing a bucket.
" } }, "document": { @@ -7223,6 +7275,12 @@ "traits": { "smithy.api#documentation": "The configuration that allows you to schedule a job for a future date and time in\n addition to specifying the end behavior for each job execution.
" } + }, + "destinationPackageVersions": { + "target": "com.amazonaws.iot#DestinationPackageVersions", + "traits": { + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the \n job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + } } }, "traits": { @@ -7357,6 +7415,12 @@ "traits": { "smithy.api#documentation": "Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
" } + }, + "destinationPackageVersions": { + "target": "com.amazonaws.iot#DestinationPackageVersions", + "traits": { + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + } } }, "traits": { @@ -7729,6 +7793,238 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#CreatePackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#CreatePackageRequest" + }, + "output": { + "target": "com.amazonaws.iot#CreatePackageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#ConflictException" + }, + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an IoT software package that can be deployed to your fleet.
\nRequires permission to access the CreatePackage and GetIndexingConfiguration actions.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/packages/{packageName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#CreatePackageRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the new package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "A summary of the package being created. This can be used to outline the package's contents or purpose.
" + } + }, + "tags": { + "target": "com.amazonaws.iot#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the package.
" + } + }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#CreatePackageResponse": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the package.
" + } + }, + "packageArn": { + "target": "com.amazonaws.iot#PackageArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the package.
" + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "The package description.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#CreatePackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#CreatePackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.iot#CreatePackageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#ConflictException" + }, + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new version for an existing IoT software package.
\nRequires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/packages/{packageName}/versions/{versionName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#CreatePackageVersionRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the associated package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the new package version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "A summary of the package version being created. This can be used to outline the package's contents or purpose.
" + } + }, + "attributes": { + "target": "com.amazonaws.iot#ResourceAttributes", + "traits": { + "smithy.api#documentation": "Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
\nThe combined size of all the attributes on a package version is limited to 3KB.
" + } + }, + "tags": { + "target": "com.amazonaws.iot#TagMap", + "traits": { + "smithy.api#documentation": "Metadata that can be used to manage the package version.
" + } + }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#CreatePackageVersionResponse": { + "type": "structure", + "members": { + "packageVersionArn": { + "target": "com.amazonaws.iot#PackageVersionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the package.
" + } + }, + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the associated package.
" + } + }, + "versionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the new package version.
" + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "The package version description.
" + } + }, + "attributes": { + "target": "com.amazonaws.iot#ResourceAttributes", + "traits": { + "smithy.api#documentation": "Metadata that were added to the package version that can be used to define a package version’s configuration.
" + } + }, + "status": { + "target": "com.amazonaws.iot#PackageVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the package version. For more information, see Package version lifecycle.
" + } + }, + "errorReason": { + "target": "com.amazonaws.iot#PackageVersionErrorReason", + "traits": { + "smithy.api#documentation": "Error reason for a package version failure during creation or update.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#CreatePolicy": { "type": "operation", "input": { @@ -10265,67 +10561,195 @@ "smithy.api#output": {} } }, - "com.amazonaws.iot#DeletePolicy": { + "com.amazonaws.iot#DeletePackage": { "type": "operation", "input": { - "target": "com.amazonaws.iot#DeletePolicyRequest" + "target": "com.amazonaws.iot#DeletePackageRequest" }, "output": { - "target": "smithy.api#Unit" + "target": "com.amazonaws.iot#DeletePackageResponse" }, "errors": [ { - "target": "com.amazonaws.iot#DeleteConflictException" + "target": "com.amazonaws.iot#InternalServerException" }, { - "target": "com.amazonaws.iot#InternalFailureException" + "target": "com.amazonaws.iot#ThrottlingException" }, { - "target": "com.amazonaws.iot#InvalidRequestException" + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a specific version from a software package.
\n\n Note: All package versions must be deleted before deleting the software package.
\nRequires permission to access the DeletePackageVersion action.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/packages/{packageName}", + "code": 200 }, - { - "target": "com.amazonaws.iot#ResourceNotFoundException" + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#DeletePackageRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the target package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#DeletePackageResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#DeletePackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#DeletePackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.iot#DeletePackageVersionResponse" + }, + "errors": [ { - "target": "com.amazonaws.iot#ServiceUnavailableException" + "target": "com.amazonaws.iot#InternalServerException" }, { "target": "com.amazonaws.iot#ThrottlingException" }, { - "target": "com.amazonaws.iot#UnauthorizedException" + "target": "com.amazonaws.iot#ValidationException" } ], "traits": { - "smithy.api#documentation": "Deletes the specified policy.
\nA policy cannot be deleted if it has non-default versions or it is attached to any\n certificate.
\nTo delete a policy, use the DeletePolicyVersion action to delete all non-default\n versions of the policy; use the DetachPolicy action to detach the policy from any\n certificate; and then use the DeletePolicy action to delete the policy.
\nWhen a policy is deleted using DeletePolicy, its default version is deleted with\n it.
\nBecause of the distributed nature of Amazon Web Services, it can take up to five minutes after\n a policy is detached before it's ready to be deleted.
\nRequires permission to access the DeletePolicy action.
", + "smithy.api#documentation": "Deletes a specific version from a software package.
\n\n Note: If a package version is designated as default, you must remove the designation from the package using the UpdatePackage action.
", "smithy.api#http": { "method": "DELETE", - "uri": "/policies/{policyName}", + "uri": "/packages/{packageName}/versions/{versionName}", "code": 200 - } + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.iot#DeletePolicyRequest": { + "com.amazonaws.iot#DeletePackageVersionRequest": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "packageName": { + "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the policy to delete.
", + "smithy.api#documentation": "The name of the associated package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the target package version.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } } }, "traits": { - "smithy.api#documentation": "The input for the DeletePolicy operation.
", "smithy.api#input": {} } }, - "com.amazonaws.iot#DeletePolicyVersion": { + "com.amazonaws.iot#DeletePackageVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#DeletePolicy": { "type": "operation", "input": { - "target": "com.amazonaws.iot#DeletePolicyVersionRequest" + "target": "com.amazonaws.iot#DeletePolicyRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.iot#DeleteConflictException" + }, + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified policy.
\nA policy cannot be deleted if it has non-default versions or it is attached to any\n certificate.
\nTo delete a policy, use the DeletePolicyVersion action to delete all non-default\n versions of the policy; use the DetachPolicy action to detach the policy from any\n certificate; and then use the DeletePolicy action to delete the policy.
\nWhen a policy is deleted using DeletePolicy, its default version is deleted with\n it.
\nBecause of the distributed nature of Amazon Web Services, it can take up to five minutes after\n a policy is detached before it's ready to be deleted.
\nRequires permission to access the DeletePolicy action.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/policies/{policyName}", + "code": 200 + } + } + }, + "com.amazonaws.iot#DeletePolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the DeletePolicy operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#DeletePolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#DeletePolicyVersionRequest" }, "output": { "target": "smithy.api#Unit" @@ -12977,6 +13401,12 @@ "traits": { "smithy.api#documentation": "Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.
" } + }, + "destinationPackageVersions": { + "target": "com.amazonaws.iot#DestinationPackageVersions", + "traits": { + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + } } }, "traits": { @@ -14221,6 +14651,12 @@ "smithy.api#documentation": "Describes the location of the updated firmware.
" } }, + "com.amazonaws.iot#DestinationPackageVersions": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#PackageVersionArn" + } + }, "com.amazonaws.iot#DetachPolicy": { "type": "operation", "input": { @@ -15082,7 +15518,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 30, + "min": 1, "max": 1430 } } @@ -15399,6 +15835,9 @@ "smithy.api#default": false } }, + "com.amazonaws.iot#EnabledBoolean": { + "type": "boolean" + }, "com.amazonaws.iot#EndpointAddress": { "type": "string" }, @@ -16656,394 +17095,648 @@ "smithy.api#output": {} } }, - "com.amazonaws.iot#GetPercentiles": { + "com.amazonaws.iot#GetPackage": { "type": "operation", "input": { - "target": "com.amazonaws.iot#GetPercentilesRequest" + "target": "com.amazonaws.iot#GetPackageRequest" }, "output": { - "target": "com.amazonaws.iot#GetPercentilesResponse" + "target": "com.amazonaws.iot#GetPackageResponse" }, "errors": [ { - "target": "com.amazonaws.iot#IndexNotReadyException" - }, - { - "target": "com.amazonaws.iot#InternalFailureException" - }, - { - "target": "com.amazonaws.iot#InvalidAggregationException" - }, - { - "target": "com.amazonaws.iot#InvalidQueryException" - }, - { - "target": "com.amazonaws.iot#InvalidRequestException" + "target": "com.amazonaws.iot#InternalServerException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, - { - "target": "com.amazonaws.iot#ServiceUnavailableException" - }, { "target": "com.amazonaws.iot#ThrottlingException" }, { - "target": "com.amazonaws.iot#UnauthorizedException" + "target": "com.amazonaws.iot#ValidationException" } ], "traits": { - "smithy.api#documentation": "Groups the aggregated values that match the query into percentile groupings. The default \n percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own \n when you call GetPercentiles. This function returns a value for each \n percentile group specified (or the default percentile groupings). The percentile group \n \"1\" contains the aggregated field value that occurs in approximately one percent of the \n values that match the query. The percentile group \"5\" contains the aggregated field value \n that occurs in approximately five percent of the values that match the query, and so on. \n The result is an approximation, the more values that match the query, the more accurate \n the percentile values.
Requires permission to access the GetPercentiles action.
", + "smithy.api#documentation": "Gets information about the specified software package.
\nRequires permission to access the GetPackage action.
", "smithy.api#http": { - "method": "POST", - "uri": "/indices/percentiles", + "method": "GET", + "uri": "/packages/{packageName}", "code": 200 } } }, - "com.amazonaws.iot#GetPercentilesRequest": { - "type": "structure", - "members": { - "indexName": { - "target": "com.amazonaws.iot#IndexName", - "traits": { - "smithy.api#documentation": "The name of the index to search.
" - } - }, - "queryString": { - "target": "com.amazonaws.iot#QueryString", - "traits": { - "smithy.api#documentation": "The search query string.
", - "smithy.api#required": {} - } - }, - "aggregationField": { - "target": "com.amazonaws.iot#AggregationField", - "traits": { - "smithy.api#documentation": "The field to aggregate.
" - } - }, - "queryVersion": { - "target": "com.amazonaws.iot#QueryVersion", - "traits": { - "smithy.api#documentation": "The query version.
" - } - }, - "percents": { - "target": "com.amazonaws.iot#PercentList", - "traits": { - "smithy.api#documentation": "The percentile groups returned.
" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.iot#GetPercentilesResponse": { - "type": "structure", - "members": { - "percentiles": { - "target": "com.amazonaws.iot#Percentiles", - "traits": { - "smithy.api#documentation": "The percentile values of the aggregated fields.
" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.iot#GetPolicy": { + "com.amazonaws.iot#GetPackageConfiguration": { "type": "operation", "input": { - "target": "com.amazonaws.iot#GetPolicyRequest" + "target": "com.amazonaws.iot#GetPackageConfigurationRequest" }, "output": { - "target": "com.amazonaws.iot#GetPolicyResponse" + "target": "com.amazonaws.iot#GetPackageConfigurationResponse" }, "errors": [ { - "target": "com.amazonaws.iot#InternalFailureException" - }, - { - "target": "com.amazonaws.iot#InvalidRequestException" - }, - { - "target": "com.amazonaws.iot#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.iot#ServiceUnavailableException" + "target": "com.amazonaws.iot#InternalServerException" }, { "target": "com.amazonaws.iot#ThrottlingException" - }, - { - "target": "com.amazonaws.iot#UnauthorizedException" } ], "traits": { - "smithy.api#documentation": "Gets information about the specified policy with the policy document of the default\n version.
\nRequires permission to access the GetPolicy action.
", + "smithy.api#documentation": "Gets information about the specified software package's configuration.
\nRequires permission to access the GetPackageConfiguration action.
", "smithy.api#http": { "method": "GET", - "uri": "/policies/{policyName}", + "uri": "/package-configuration", "code": 200 } } }, - "com.amazonaws.iot#GetPolicyRequest": { + "com.amazonaws.iot#GetPackageConfigurationRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#GetPackageConfigurationResponse": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "versionUpdateByJobsConfig": { + "target": "com.amazonaws.iot#VersionUpdateByJobsConfig", "traits": { - "smithy.api#documentation": "The name of the policy.
", + "smithy.api#documentation": "The version that is associated to a specific job.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#GetPackageRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the target package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The input for the GetPolicy operation.
", "smithy.api#input": {} } }, - "com.amazonaws.iot#GetPolicyResponse": { + "com.amazonaws.iot#GetPackageResponse": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "packageName": { + "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The policy name.
" + "smithy.api#documentation": "The name of the package.
" } }, - "policyArn": { - "target": "com.amazonaws.iot#PolicyArn", + "packageArn": { + "target": "com.amazonaws.iot#PackageArn", "traits": { - "smithy.api#documentation": "The policy ARN.
" + "smithy.api#documentation": "The ARN for the package.
" } }, - "policyDocument": { - "target": "com.amazonaws.iot#PolicyDocument", + "description": { + "target": "com.amazonaws.iot#ResourceDescription", "traits": { - "smithy.api#documentation": "The JSON document that describes the policy.
" + "smithy.api#documentation": "The package description.
" } }, - "defaultVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "defaultVersionName": { + "target": "com.amazonaws.iot#VersionName", "traits": { - "smithy.api#documentation": "The default policy version ID.
" + "smithy.api#documentation": "The name of the default package version.
" } }, "creationDate": { - "target": "com.amazonaws.iot#DateType", + "target": "com.amazonaws.iot#CreationDate", "traits": { - "smithy.api#documentation": "The date the policy was created.
" + "smithy.api#documentation": "The date the package was created.
" } }, "lastModifiedDate": { - "target": "com.amazonaws.iot#DateType", - "traits": { - "smithy.api#documentation": "The date the policy was last modified.
" - } - }, - "generationId": { - "target": "com.amazonaws.iot#GenerationId", + "target": "com.amazonaws.iot#LastModifiedDate", "traits": { - "smithy.api#documentation": "The generation ID of the policy.
" + "smithy.api#documentation": "The date when the package was last updated.
" } } }, "traits": { - "smithy.api#documentation": "The output from the GetPolicy operation.
", "smithy.api#output": {} } }, - "com.amazonaws.iot#GetPolicyVersion": { + "com.amazonaws.iot#GetPackageVersion": { "type": "operation", "input": { - "target": "com.amazonaws.iot#GetPolicyVersionRequest" + "target": "com.amazonaws.iot#GetPackageVersionRequest" }, "output": { - "target": "com.amazonaws.iot#GetPolicyVersionResponse" + "target": "com.amazonaws.iot#GetPackageVersionResponse" }, "errors": [ { - "target": "com.amazonaws.iot#InternalFailureException" - }, - { - "target": "com.amazonaws.iot#InvalidRequestException" + "target": "com.amazonaws.iot#InternalServerException" }, { "target": "com.amazonaws.iot#ResourceNotFoundException" }, - { - "target": "com.amazonaws.iot#ServiceUnavailableException" - }, { "target": "com.amazonaws.iot#ThrottlingException" }, { - "target": "com.amazonaws.iot#UnauthorizedException" + "target": "com.amazonaws.iot#ValidationException" } ], "traits": { - "smithy.api#documentation": "Gets information about the specified policy version.
\nRequires permission to access the GetPolicyVersion action.
", + "smithy.api#documentation": "Gets information about the specified package version.
\nRequires permission to access the GetPackageVersion action.
", "smithy.api#http": { "method": "GET", - "uri": "/policies/{policyName}/version/{policyVersionId}", + "uri": "/packages/{packageName}/versions/{versionName}", "code": 200 } } }, - "com.amazonaws.iot#GetPolicyVersionRequest": { + "com.amazonaws.iot#GetPackageVersionRequest": { "type": "structure", "members": { - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "packageName": { + "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The name of the policy.
", + "smithy.api#documentation": "The name of the associated package.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "versionName": { + "target": "com.amazonaws.iot#VersionName", "traits": { - "smithy.api#documentation": "The policy version ID.
", + "smithy.api#documentation": "The name of the target package version.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The input for the GetPolicyVersion operation.
", "smithy.api#input": {} } }, - "com.amazonaws.iot#GetPolicyVersionResponse": { + "com.amazonaws.iot#GetPackageVersionResponse": { "type": "structure", "members": { - "policyArn": { - "target": "com.amazonaws.iot#PolicyArn", + "packageVersionArn": { + "target": "com.amazonaws.iot#PackageVersionArn", "traits": { - "smithy.api#documentation": "The policy ARN.
" + "smithy.api#documentation": "The ARN for the package version.
" } }, - "policyName": { - "target": "com.amazonaws.iot#PolicyName", + "packageName": { + "target": "com.amazonaws.iot#PackageName", "traits": { - "smithy.api#documentation": "The policy name.
" + "smithy.api#documentation": "The name of the package.
" } }, - "policyDocument": { - "target": "com.amazonaws.iot#PolicyDocument", + "versionName": { + "target": "com.amazonaws.iot#VersionName", "traits": { - "smithy.api#documentation": "The JSON document that describes the policy.
" + "smithy.api#documentation": "The name of the package version.
" } }, - "policyVersionId": { - "target": "com.amazonaws.iot#PolicyVersionId", + "description": { + "target": "com.amazonaws.iot#ResourceDescription", "traits": { - "smithy.api#documentation": "The policy version ID.
" + "smithy.api#documentation": "The package version description.
" } }, - "isDefaultVersion": { - "target": "com.amazonaws.iot#IsDefaultVersion", + "attributes": { + "target": "com.amazonaws.iot#ResourceAttributes", "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether the policy version is the default.
" + "smithy.api#documentation": "Metadata that were added to the package version that can be used to define a package version’s configuration.
" } }, - "creationDate": { - "target": "com.amazonaws.iot#DateType", + "status": { + "target": "com.amazonaws.iot#PackageVersionStatus", "traits": { - "smithy.api#documentation": "The date the policy was created.
" + "smithy.api#documentation": "The status associated to the package version. For more information, see Package version lifecycle.
" } }, - "lastModifiedDate": { - "target": "com.amazonaws.iot#DateType", + "errorReason": { + "target": "com.amazonaws.iot#PackageVersionErrorReason", "traits": { - "smithy.api#documentation": "The date the policy was last modified.
" + "smithy.api#documentation": "Error reason for a package version failure during creation or update.
" } }, - "generationId": { - "target": "com.amazonaws.iot#GenerationId", + "creationDate": { + "target": "com.amazonaws.iot#CreationDate", "traits": { - "smithy.api#documentation": "The generation ID of the policy version.
" + "smithy.api#documentation": "The date when the package version was created.
" } - } - }, - "traits": { - "smithy.api#documentation": "The output from the GetPolicyVersion operation.
", - "smithy.api#output": {} - } - }, - "com.amazonaws.iot#GetRegistrationCode": { - "type": "operation", - "input": { - "target": "com.amazonaws.iot#GetRegistrationCodeRequest" - }, - "output": { - "target": "com.amazonaws.iot#GetRegistrationCodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.iot#InternalFailureException" - }, - { - "target": "com.amazonaws.iot#InvalidRequestException" - }, - { - "target": "com.amazonaws.iot#ServiceUnavailableException" - }, - { - "target": "com.amazonaws.iot#ThrottlingException" }, - { - "target": "com.amazonaws.iot#UnauthorizedException" - } - ], - "traits": { - "smithy.api#documentation": "Gets a registration code used to register a CA certificate with IoT.
\nRequires permission to access the GetRegistrationCode action.
", - "smithy.api#http": { - "method": "GET", - "uri": "/registrationcode", - "code": 200 - } - } - }, - "com.amazonaws.iot#GetRegistrationCodeRequest": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "The input to the GetRegistrationCode operation.
", - "smithy.api#input": {} - } - }, - "com.amazonaws.iot#GetRegistrationCodeResponse": { - "type": "structure", - "members": { - "registrationCode": { - "target": "com.amazonaws.iot#RegistrationCode", + "lastModifiedDate": { + "target": "com.amazonaws.iot#LastModifiedDate", "traits": { - "smithy.api#documentation": "The CA certificate registration code.
" + "smithy.api#documentation": "The date when the package version was last updated.
" } } }, "traits": { - "smithy.api#documentation": "The output from the GetRegistrationCode operation.
", "smithy.api#output": {} } }, - "com.amazonaws.iot#GetStatistics": { + "com.amazonaws.iot#GetPercentiles": { "type": "operation", "input": { - "target": "com.amazonaws.iot#GetStatisticsRequest" + "target": "com.amazonaws.iot#GetPercentilesRequest" }, "output": { - "target": "com.amazonaws.iot#GetStatisticsResponse" + "target": "com.amazonaws.iot#GetPercentilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#IndexNotReadyException" + }, + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidAggregationException" + }, + { + "target": "com.amazonaws.iot#InvalidQueryException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Groups the aggregated values that match the query into percentile groupings. The default \n percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own \n when you call GetPercentiles. This function returns a value for each \n percentile group specified (or the default percentile groupings). The percentile group \n \"1\" contains the aggregated field value that occurs in approximately one percent of the \n values that match the query. The percentile group \"5\" contains the aggregated field value \n that occurs in approximately five percent of the values that match the query, and so on. \n The result is an approximation, the more values that match the query, the more accurate \n the percentile values.
Requires permission to access the GetPercentiles action.
", + "smithy.api#http": { + "method": "POST", + "uri": "/indices/percentiles", + "code": 200 + } + } + }, + "com.amazonaws.iot#GetPercentilesRequest": { + "type": "structure", + "members": { + "indexName": { + "target": "com.amazonaws.iot#IndexName", + "traits": { + "smithy.api#documentation": "The name of the index to search.
" + } + }, + "queryString": { + "target": "com.amazonaws.iot#QueryString", + "traits": { + "smithy.api#documentation": "The search query string.
", + "smithy.api#required": {} + } + }, + "aggregationField": { + "target": "com.amazonaws.iot#AggregationField", + "traits": { + "smithy.api#documentation": "The field to aggregate.
" + } + }, + "queryVersion": { + "target": "com.amazonaws.iot#QueryVersion", + "traits": { + "smithy.api#documentation": "The query version.
" + } + }, + "percents": { + "target": "com.amazonaws.iot#PercentList", + "traits": { + "smithy.api#documentation": "The percentile groups returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#GetPercentilesResponse": { + "type": "structure", + "members": { + "percentiles": { + "target": "com.amazonaws.iot#Percentiles", + "traits": { + "smithy.api#documentation": "The percentile values of the aggregated fields.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#GetPolicyRequest" + }, + "output": { + "target": "com.amazonaws.iot#GetPolicyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified policy with the policy document of the default\n version.
\nRequires permission to access the GetPolicy action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policies/{policyName}", + "code": 200 + } + } + }, + "com.amazonaws.iot#GetPolicyRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the GetPolicy operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#GetPolicyResponse": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "The policy name.
" + } + }, + "policyArn": { + "target": "com.amazonaws.iot#PolicyArn", + "traits": { + "smithy.api#documentation": "The policy ARN.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.iot#PolicyDocument", + "traits": { + "smithy.api#documentation": "The JSON document that describes the policy.
" + } + }, + "defaultVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", + "traits": { + "smithy.api#documentation": "The default policy version ID.
" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "The date the policy was created.
" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "The date the policy was last modified.
" + } + }, + "generationId": { + "target": "com.amazonaws.iot#GenerationId", + "traits": { + "smithy.api#documentation": "The generation ID of the policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output from the GetPolicy operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#GetPolicyVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#GetPolicyVersionRequest" + }, + "output": { + "target": "com.amazonaws.iot#GetPolicyVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about the specified policy version.
\nRequires permission to access the GetPolicyVersion action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/policies/{policyName}/version/{policyVersionId}", + "code": 200 + } + } + }, + "com.amazonaws.iot#GetPolicyVersionRequest": { + "type": "structure", + "members": { + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", + "traits": { + "smithy.api#documentation": "The policy version ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input for the GetPolicyVersion operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#GetPolicyVersionResponse": { + "type": "structure", + "members": { + "policyArn": { + "target": "com.amazonaws.iot#PolicyArn", + "traits": { + "smithy.api#documentation": "The policy ARN.
" + } + }, + "policyName": { + "target": "com.amazonaws.iot#PolicyName", + "traits": { + "smithy.api#documentation": "The policy name.
" + } + }, + "policyDocument": { + "target": "com.amazonaws.iot#PolicyDocument", + "traits": { + "smithy.api#documentation": "The JSON document that describes the policy.
" + } + }, + "policyVersionId": { + "target": "com.amazonaws.iot#PolicyVersionId", + "traits": { + "smithy.api#documentation": "The policy version ID.
" + } + }, + "isDefaultVersion": { + "target": "com.amazonaws.iot#IsDefaultVersion", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether the policy version is the default.
" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "The date the policy was created.
" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#DateType", + "traits": { + "smithy.api#documentation": "The date the policy was last modified.
" + } + }, + "generationId": { + "target": "com.amazonaws.iot#GenerationId", + "traits": { + "smithy.api#documentation": "The generation ID of the policy version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output from the GetPolicyVersion operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#GetRegistrationCode": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#GetRegistrationCodeRequest" + }, + "output": { + "target": "com.amazonaws.iot#GetRegistrationCodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalFailureException" + }, + { + "target": "com.amazonaws.iot#InvalidRequestException" + }, + { + "target": "com.amazonaws.iot#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#UnauthorizedException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a registration code used to register a CA certificate with IoT.
\nRequires permission to access the GetRegistrationCode action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/registrationcode", + "code": 200 + } + } + }, + "com.amazonaws.iot#GetRegistrationCodeRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The input to the GetRegistrationCode operation.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#GetRegistrationCodeResponse": { + "type": "structure", + "members": { + "registrationCode": { + "target": "com.amazonaws.iot#RegistrationCode", + "traits": { + "smithy.api#documentation": "The CA certificate registration code.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The output from the GetRegistrationCode operation.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#GetStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#GetStatisticsRequest" + }, + "output": { + "target": "com.amazonaws.iot#GetStatisticsResponse" }, "errors": [ { @@ -18090,6 +18783,12 @@ "traits": { "smithy.api#documentation": "Displays the next seven maintenance window occurrences and their start times.
" } + }, + "destinationPackageVersions": { + "target": "com.amazonaws.iot#DestinationPackageVersions", + "traits": { + "smithy.api#documentation": "The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
\n\n Note:The following Length Constraints relates to a single string. \n Up to five strings are allowed.
" + } } }, "traits": { @@ -21540,6 +22239,173 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#ListPackageVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListPackageVersionsRequest" + }, + "output": { + "target": "com.amazonaws.iot#ListPackageVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the software package versions associated to the account.
\nRequires permission to access the ListPackageVersions action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/{packageName}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "packageVersionSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iot#ListPackageVersionsRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the target package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "status": { + "target": "com.amazonaws.iot#PackageVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the package version. For more information, see Package version lifecycle.
", + "smithy.api#httpQuery": "status" + } + }, + "maxResults": { + "target": "com.amazonaws.iot#PackageCatalogMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return at one time.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#ListPackageVersionsResponse": { + "type": "structure", + "members": { + "packageVersionSummaries": { + "target": "com.amazonaws.iot#PackageVersionSummaryList", + "traits": { + "smithy.api#documentation": "Lists the package versions associated to the package.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#ListPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#ListPackagesRequest" + }, + "output": { + "target": "com.amazonaws.iot#ListPackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the software packages associated to the account.
\nRequires permission to access the ListPackages action.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "packageSummaries", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.iot#ListPackagesRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.iot#PackageCatalogMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results returned at one time.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#ListPackagesResponse": { + "type": "structure", + "members": { + "packageSummaries": { + "target": "com.amazonaws.iot#PackageSummaryList", + "traits": { + "smithy.api#documentation": "The software package summary.
" + } + }, + "nextToken": { + "target": "com.amazonaws.iot#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#ListPolicies": { "type": "operation", "input": { @@ -25587,6 +26453,163 @@ "smithy.api#default": false } }, + "com.amazonaws.iot#PackageArn": { + "type": "string" + }, + "com.amazonaws.iot#PackageCatalogMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.iot#PackageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_.]+$" + } + }, + "com.amazonaws.iot#PackageSummary": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name for the target package.
" + } + }, + "defaultVersionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the default package version.
" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#CreationDate", + "traits": { + "smithy.api#documentation": "The date that the package was created.
" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#LastModifiedDate", + "traits": { + "smithy.api#documentation": "The date that the package was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of information about a software package.
" + } + }, + "com.amazonaws.iot#PackageSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#PackageSummary" + } + }, + "com.amazonaws.iot#PackageVersionAction": { + "type": "enum", + "members": { + "PUBLISH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISH" + } + }, + "DEPRECATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATE" + } + } + } + }, + "com.amazonaws.iot#PackageVersionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": "^arn:[!-~]+$" + } + }, + "com.amazonaws.iot#PackageVersionErrorReason": { + "type": "string" + }, + "com.amazonaws.iot#PackageVersionStatus": { + "type": "enum", + "members": { + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "PUBLISHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PUBLISHED" + } + }, + "DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEPRECATED" + } + } + } + }, + "com.amazonaws.iot#PackageVersionSummary": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the associated software package.
" + } + }, + "versionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the target package version.
" + } + }, + "status": { + "target": "com.amazonaws.iot#PackageVersionStatus", + "traits": { + "smithy.api#documentation": "The status of the package version. For more information, see Package version lifecycle.
" + } + }, + "creationDate": { + "target": "com.amazonaws.iot#CreationDate", + "traits": { + "smithy.api#documentation": "The date that the package version was created.
" + } + }, + "lastModifiedDate": { + "target": "com.amazonaws.iot#LastModifiedDate", + "traits": { + "smithy.api#documentation": "The date that the package version was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of information about a package version.
" + } + }, + "com.amazonaws.iot#PackageVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#PackageVersionSummary" + } + }, "com.amazonaws.iot#PageSize": { "type": "integer", "traits": { @@ -27283,6 +28306,47 @@ "target": "com.amazonaws.iot#ResourceArn" } }, + "com.amazonaws.iot#ResourceAttributeKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[a-zA-Z0-9:_-]+$" + } + }, + "com.amazonaws.iot#ResourceAttributeValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[^\\p{C}]+$" + } + }, + "com.amazonaws.iot#ResourceAttributes": { + "type": "map", + "key": { + "target": "com.amazonaws.iot#ResourceAttributeKey" + }, + "value": { + "target": "com.amazonaws.iot#ResourceAttributeValue" + }, + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.iot#ResourceDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[^\\p{C}]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.iot#ResourceIdentifier": { "type": "structure", "members": { @@ -28207,6 +29271,19 @@ "com.amazonaws.iot#ServiceName": { "type": "string" }, + "com.amazonaws.iot#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iot#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "A limit has been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, "com.amazonaws.iot#ServiceType": { "type": "enum", "members": { @@ -29587,6 +30664,21 @@ "target": "com.amazonaws.iot#Tag" } }, + "com.amazonaws.iot#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.iot#TagKey" + }, + "value": { + "target": "com.amazonaws.iot#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.iot#TagResource": { "type": "operation", "input": { @@ -31420,6 +32512,9 @@ "smithy.api#default": false } }, + "com.amazonaws.iot#UnsetDefaultVersion": { + "type": "boolean" + }, "com.amazonaws.iot#UnsignedLong": { "type": "long", "traits": { @@ -32780,6 +33875,234 @@ "smithy.api#output": {} } }, + "com.amazonaws.iot#UpdatePackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdatePackageRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdatePackageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the supported fields for a specific package.
\nRequires permission to access the UpdatePackage and GetIndexingConfiguration actions.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/packages/{packageName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#UpdatePackageConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdatePackageConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdatePackageConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the package configuration.
\nRequires permission to access the UpdatePackageConfiguration and iam:PassRole actions.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/package-configuration", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#UpdatePackageConfigurationRequest": { + "type": "structure", + "members": { + "versionUpdateByJobsConfig": { + "target": "com.amazonaws.iot#VersionUpdateByJobsConfig", + "traits": { + "smithy.api#documentation": "Configuration to manage job's package version reporting. This updates the thing's reserved named shadow that the job targets.
" + } + }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#UpdatePackageConfigurationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#UpdatePackageRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the target package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "The package description.
" + } + }, + "defaultVersionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the default package version.
\n\n Note: You cannot name a defaultVersion\n and set unsetDefaultVersion equal to true at the same time.
Indicates whether you want to remove the named default package version from the software package. \n Set as true to remove the default package version.
\n Note: You cannot name a defaultVersion\n and set unsetDefaultVersion equal to true at the same time.
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#UpdatePackageResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.iot#UpdatePackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.iot#UpdatePackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.iot#UpdatePackageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iot#InternalServerException" + }, + { + "target": "com.amazonaws.iot#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iot#ThrottlingException" + }, + { + "target": "com.amazonaws.iot#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the supported fields for a specific package version.
\nRequires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/packages/{packageName}/versions/{versionName}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.iot#UpdatePackageVersionRequest": { + "type": "structure", + "members": { + "packageName": { + "target": "com.amazonaws.iot#PackageName", + "traits": { + "smithy.api#documentation": "The name of the associated software package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "versionName": { + "target": "com.amazonaws.iot#VersionName", + "traits": { + "smithy.api#documentation": "The name of the target package version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.iot#ResourceDescription", + "traits": { + "smithy.api#documentation": "The package version description.
" + } + }, + "attributes": { + "target": "com.amazonaws.iot#ResourceAttributes", + "traits": { + "smithy.api#documentation": "Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
\n\n Note: Attributes can be updated only when the package version\n is in a draft state.
\nThe combined size of all the attributes on a package version is limited to 3KB.
" + } + }, + "action": { + "target": "com.amazonaws.iot#PackageVersionAction", + "traits": { + "smithy.api#documentation": "The status that the package version should be assigned. For more information, see Package version lifecycle.
" + } + }, + "clientToken": { + "target": "com.amazonaws.iot#ClientToken", + "traits": { + "smithy.api#documentation": "A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. \n Don't reuse this client token if a new idempotent request is required.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.iot#UpdatePackageVersionResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.iot#UpdateProvisioningTemplate": { "type": "operation", "input": { @@ -33786,6 +35109,19 @@ "target": "com.amazonaws.iot#ValidationError" } }, + "com.amazonaws.iot#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.iot#ErrorMessage2" + } + }, + "traits": { + "smithy.api#documentation": "The request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.iot#Value": { "type": "string", "traits": { @@ -33863,12 +35199,42 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.iot#VersionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_.]+$" + } + }, "com.amazonaws.iot#VersionNumber": { "type": "long", "traits": { "smithy.api#default": 0 } }, + "com.amazonaws.iot#VersionUpdateByJobsConfig": { + "type": "structure", + "members": { + "enabled": { + "target": "com.amazonaws.iot#EnabledBoolean", + "traits": { + "smithy.api#documentation": "Indicates whether the Job is enabled or not.
" + } + }, + "roleArn": { + "target": "com.amazonaws.iot#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that grants permission to the IoT\n jobs service to update the reserved named shadow when the job successfully completes.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration to manage IoT Job's package version reporting. If configured, Jobs updates the thing's reserved named shadow with the package version information up on successful job completion.
\n\n Note: For each job, the destinationPackageVersions attribute has to be set with the correct data for Jobs to report to the thing shadow.\n
" + } + }, "com.amazonaws.iot#VersionsLimitExceededException": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json index 2a83eaeeb8e..fdde42439a7 100644 --- a/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json +++ b/codegen/sdk-codegen/aws-models/iotdeviceadvisor.2020-09-18.json @@ -1653,7 +1653,7 @@ "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "The resource ARN of the IoT Device Advisor resource.\n This can be SuiteDefinition ARN or SuiteRun ARN.
", + "smithy.api#documentation": "The resource ARN of the IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1757,7 +1757,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 2048 } } @@ -2038,7 +2038,7 @@ "rootGroup": { "target": "com.amazonaws.iotdeviceadvisor#RootGroup", "traits": { - "smithy.api#documentation": "Gets the test suite root group. This is a required parameter.
", + "smithy.api#documentation": "Gets the test suite root group. This is a required parameter.\n For updating or creating the latest qualification suite, \n if intendedForQualification is set to true, \n rootGroup can be an empty string. If intendedForQualification is false, \n rootGroup cannot be an empty string.\n If rootGroup is empty, and \n intendedForQualification is set to true, \n all the qualification tests are included, and the configuration is default.
\n For a qualification suite, the minimum length is 0, and the maximum is 2048. For a \n non-qualification suite, the minimum length is 1, and the maximum is 2048.\n
", "smithy.api#required": {} } }, @@ -2142,7 +2142,7 @@ "primaryDevice": { "target": "com.amazonaws.iotdeviceadvisor#DeviceUnderTest", "traits": { - "smithy.api#documentation": "Sets the primary device for the test suite run. This requires\n a thing ARN or a certificate ARN.
", + "smithy.api#documentation": "Sets the primary device for the test suite run. This requires a thing ARN or a\n certificate ARN.
", "smithy.api#required": {} } }, @@ -2373,7 +2373,7 @@ "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource. \n This can be SuiteDefinition ARN or SuiteRun ARN.
", + "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2507,7 +2507,7 @@ "systemMessage": { "target": "com.amazonaws.iotdeviceadvisor#SystemMessage", "traits": { - "smithy.api#documentation": "\n
" + "smithy.api#documentation": "Provides test case scenario system messages if any.
" } } }, @@ -2669,7 +2669,7 @@ "resourceArn": { "target": "com.amazonaws.iotdeviceadvisor#AmazonResourceName", "traits": { - "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource.\n This can be SuiteDefinition ARN or SuiteRun ARN.
", + "smithy.api#documentation": "The resource ARN of an IoT Device Advisor resource. This can be SuiteDefinition ARN or\n SuiteRun ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json index df1e4216396..31447c1e408 100644 --- a/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json +++ b/codegen/sdk-codegen/aws-models/lambda.2015-03-31.json @@ -6450,6 +6450,9 @@ { "target": "com.amazonaws.lambda#KMSNotFoundException" }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, { "target": "com.amazonaws.lambda#RequestTooLargeException" }, @@ -6666,6 +6669,9 @@ { "target": "com.amazonaws.lambda#KMSNotFoundException" }, + { + "target": "com.amazonaws.lambda#RecursiveInvocationException" + }, { "target": "com.amazonaws.lambda#RequestTooLargeException" }, @@ -9485,6 +9491,28 @@ } } }, + "com.amazonaws.lambda#RecursiveInvocationException": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception type.
" + } + }, + "Message": { + "target": "com.amazonaws.lambda#String", + "traits": { + "smithy.api#documentation": "The exception message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Lambda has detected your function being invoked in a recursive loop with other Amazon Web Services resources and stopped your function's invocation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.lambda#RemoveLayerVersionPermission": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json b/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json index 855a2ee2aaf..66f19ced73b 100644 --- a/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json +++ b/codegen/sdk-codegen/aws-models/lex-models-v2.2020-08-07.json @@ -29,6 +29,43 @@ ] }, "shapes": { + "com.amazonaws.lexmodelsv2#ActiveContext": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#ActiveContextName", + "traits": { + "smithy.api#documentation": "The name of active context.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The active context used in the test execution.
" + } + }, + "com.amazonaws.lexmodelsv2#ActiveContextList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ActiveContext" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.lexmodelsv2#ActiveContextName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^([A-Za-z]_?)+$" + } + }, "com.amazonaws.lexmodelsv2#AdvancedRecognitionSetting": { "type": "structure", "members": { @@ -43,6 +80,57 @@ "smithy.api#documentation": "Provides settings that enable advanced recognition settings for slot values.
" } }, + "com.amazonaws.lexmodelsv2#AgentTurnResult": { + "type": "structure", + "members": { + "expectedAgentPrompt": { + "target": "com.amazonaws.lexmodelsv2#TestSetAgentPrompt", + "traits": { + "smithy.api#documentation": "The expected agent prompt for the agent turn in a test set execution.
", + "smithy.api#required": {} + } + }, + "actualAgentPrompt": { + "target": "com.amazonaws.lexmodelsv2#TestSetAgentPrompt", + "traits": { + "smithy.api#documentation": "The actual agent prompt for the agent turn in a test set execution.
" + } + }, + "errorDetails": { + "target": "com.amazonaws.lexmodelsv2#ExecutionErrorDetails" + }, + "actualElicitedSlot": { + "target": "com.amazonaws.lexmodelsv2#TestResultSlotName", + "traits": { + "smithy.api#documentation": "The actual elicited slot for the agent turn in a test set execution.
" + } + }, + "actualIntent": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The actual intent for the agent turn in a test set execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The information about the agent turn in a test set execution.
" + } + }, + "com.amazonaws.lexmodelsv2#AgentTurnSpecification": { + "type": "structure", + "members": { + "agentPrompt": { + "target": "com.amazonaws.lexmodelsv2#TestSetAgentPrompt", + "traits": { + "smithy.api#documentation": "The agent prompt for the agent turn in a test set.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The specification of an agent turn.
" + } + }, "com.amazonaws.lexmodelsv2#AggregatedUtterancesFilter": { "type": "structure", "members": { @@ -348,6 +436,16 @@ "smithy.api#documentation": "Specifies the audio and DTMF input specification.
" } }, + "com.amazonaws.lexmodelsv2#AudioFileS3Location": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^s3://([a-z0-9\\\\.-]+)/(.+)$" + } + }, "com.amazonaws.lexmodelsv2#AudioLogDestination": { "type": "structure", "members": { @@ -498,6 +596,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#BatchCreateCustomVocabularyItemResponse": { @@ -533,6 +634,9 @@ "smithy.api#documentation": "A list of custom vocabulary items that were \n successfully created during the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#BatchDeleteCustomVocabularyItem": { @@ -603,6 +707,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#BatchDeleteCustomVocabularyItemResponse": { @@ -638,6 +745,9 @@ "smithy.api#documentation": "A list of custom vocabulary items that were \n successfully deleted during the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#BatchUpdateCustomVocabularyItem": { @@ -708,6 +818,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#BatchUpdateCustomVocabularyItemResponse": { @@ -743,6 +856,9 @@ "smithy.api#documentation": "A list of custom vocabulary items that were \n successfully updated during the operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#Boolean": { @@ -898,7 +1014,7 @@ "botAliasStatus": { "target": "com.amazonaws.lexmodelsv2#BotAliasStatus", "traits": { - "smithy.api#documentation": "The current state of the bot alias. If the status is\n Available, the alias is ready for use.
The current state of the bot alias. If the status is\n Available, the alias is ready for use.
The bot Id of the bot alias used in the test set execution.
", + "smithy.api#required": {} + } + }, + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "traits": { + "smithy.api#documentation": "The bot alias Id of the bot alias used in the test set execution.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The locale Id of the bot alias used in the test set execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The target Amazon S3 location for the test set execution using a bot alias.
" + } + }, "com.amazonaws.lexmodelsv2#BotExportSpecification": { "type": "structure", "members": { @@ -966,7 +1111,7 @@ "operator": { "target": "com.amazonaws.lexmodelsv2#BotFilterOperator", "traits": { - "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListBots operation should return only aliases that\n equal the specified value. Specify CO when the\n ListBots operation should return aliases that contain\n the specified value.
The operator to use for the filter. Specify EQ when the\n ListBots operation should return only aliases that\n equal the specified value. Specify CO when the\n ListBots operation should return aliases that contain\n the specified value.
The operator to use for the filter. Specify EQ when the\n ListBotLocales operation should return only aliases\n that equal the specified value. Specify CO when the\n ListBotLocales operation should return aliases that\n contain the specified value.
The operator to use for the filter. Specify EQ when the\n ListBotLocales operation should return only aliases\n that equal the specified value. Specify CO when the\n ListBotLocales operation should return aliases that\n contain the specified value.
Provides information about an event that occurred affecting the bot\n locale.
" + "smithy.api#documentation": "Provides information about an event that occurred affecting the bot\n locale.
" } }, "com.amazonaws.lexmodelsv2#BotLocaleHistoryEventDescription": { @@ -1356,7 +1501,7 @@ "botLocaleStatus": { "target": "com.amazonaws.lexmodelsv2#BotLocaleStatus", "traits": { - "smithy.api#documentation": "The current status of the bot locale. When the status is\n Built the locale is ready for use.
The current status of the bot locale. When the status is\n Built the locale is ready for use.
Statistical information about about the intents associated with the\n bot recommendation results.
" + "smithy.api#documentation": "Statistical information about about the intents associated with the\n bot recommendation results.
" } }, "slotTypes": { "target": "com.amazonaws.lexmodelsv2#SlotTypeStatistics", "traits": { - "smithy.api#documentation": "Statistical information about the slot types associated with the bot\n recommendation results.
" + "smithy.api#documentation": "Statistical information about the slot types associated with the bot\n recommendation results.
" } } }, @@ -1480,7 +1625,7 @@ } }, "traits": { - "smithy.api#documentation": "The object representing the URL of the bot definition, the URL of\n the associated transcript, and a statistical summary of the bot\n recommendation results.
" + "smithy.api#documentation": "The object representing the URL of the bot definition, the URL of\n the associated transcript, and a statistical summary of the bot\n recommendation results.
" } }, "com.amazonaws.lexmodelsv2#BotRecommendationStatus": { @@ -1692,7 +1837,7 @@ "botStatus": { "target": "com.amazonaws.lexmodelsv2#BotStatus", "traits": { - "smithy.api#documentation": "The current status of the bot. When the status is\n Available the bot is ready for use.
The current status of the bot. When the status is\n Available the bot is ready for use.
A timestamp indicating the date and time that the bot was last built\n for this locale.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#BuiltInIntentSortAttribute": { @@ -2080,7 +2231,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides summary information about a built-in slot type for the\n ListBuiltInSlotTypes \n operation.
" + "smithy.api#documentation": "Provides summary information about a built-in slot type for the\n ListBuiltInSlotTypes \n operation.
" } }, "com.amazonaws.lexmodelsv2#BuiltInSlotTypeSummaryList": { @@ -2418,163 +2569,409 @@ } } }, - "com.amazonaws.lexmodelsv2#ConversationLogSettings": { + "com.amazonaws.lexmodelsv2#ConversationLevelIntentClassificationResultItem": { "type": "structure", "members": { - "textLogSettings": { - "target": "com.amazonaws.lexmodelsv2#TextLogSettingsList", + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The Amazon CloudWatch Logs settings for logging text and metadata.
" + "smithy.api#documentation": "The intent name used in the evaluation of intent level success or failure.
", + "smithy.api#required": {} } }, - "audioLogSettings": { - "target": "com.amazonaws.lexmodelsv2#AudioLogSettingsList", + "matchResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "The Amazon S3 settings for logging audio to an S3 bucket.
" + "smithy.api#documentation": "The number of times the specific intent is used in the evaluation of intent level\n success or failure.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configures conversation logging that saves audio, text, and metadata\n for the conversations with your users.
" + "smithy.api#documentation": "The item listing the evaluation of intent level success or failure.
" } }, - "com.amazonaws.lexmodelsv2#Count": { - "type": "integer" - }, - "com.amazonaws.lexmodelsv2#CreateBot": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#CreateBotRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#CreateBotResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#ConflictException" - }, - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Creates an Amazon Lex conversational bot.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/bots", - "code": 202 - } + "com.amazonaws.lexmodelsv2#ConversationLevelIntentClassificationResults": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelIntentClassificationResultItem" } }, - "com.amazonaws.lexmodelsv2#CreateBotAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#CreateBotAliasRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#CreateBotAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#ConflictException" - }, - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + "com.amazonaws.lexmodelsv2#ConversationLevelResultDetail": { + "type": "structure", + "members": { + "endToEndResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", + "traits": { + "smithy.api#documentation": "The success or failure of the streaming of the conversation.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" + "speechTranscriptionResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", + "traits": { + "smithy.api#documentation": "The speech transcription success or failure details of the conversation.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Creates an alias for the specified version of a bot. Use an alias to\n enable you to change the version of a bot without updating applications\n that use the bot.
\nFor example, you can create an alias called \"PROD\" that your\n applications use to call the Amazon Lex bot.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/bots/{botId}/botaliases", - "code": 202 - } + "smithy.api#documentation": "The conversation level details of the conversation used in the test set.
" } }, - "com.amazonaws.lexmodelsv2#CreateBotAliasRequest": { + "com.amazonaws.lexmodelsv2#ConversationLevelSlotResolutionResultItem": { "type": "structure", "members": { - "botAliasName": { + "intentName": { "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The alias to create. The name must be unique for the bot.
", + "smithy.api#documentation": "The intents used in the slots list for the slot resolution details.
", "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", + "slotName": { + "target": "com.amazonaws.lexmodelsv2#TestResultSlotName", "traits": { - "smithy.api#documentation": "A description of the alias. Use this description to help identify\n the alias.
" + "smithy.api#documentation": "The slot name in the slots list for the slot resolution details.
", + "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#NumericalBotVersion", + "matchResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "The version of the bot that this alias points to. You can use the\n UpdateBotAlias operation to change the\n bot version associated with the alias.
" + "smithy.api#documentation": "The number of matching slots used in the slots listings for the slot resolution evaluation.
", + "smithy.api#required": {} } - }, - "botAliasLocaleSettings": { - "target": "com.amazonaws.lexmodelsv2#BotAliasLocaleSettingsMap", + } + }, + "traits": { + "smithy.api#documentation": "The slots used for the slot resolution in the conversation.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLevelSlotResolutionResults": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelSlotResolutionResultItem" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLevelTestResultItem": { + "type": "structure", + "members": { + "conversationId": { + "target": "com.amazonaws.lexmodelsv2#TestSetConversationId", "traits": { - "smithy.api#documentation": "Maps configuration information to a specific locale. You can use\n this parameter to specify a specific Lambda function to run different\n functions in different locales.
" + "smithy.api#documentation": "The conversation Id of the test result evaluation item.
", + "smithy.api#required": {} } }, - "conversationLogSettings": { - "target": "com.amazonaws.lexmodelsv2#ConversationLogSettings", + "endToEndResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "Specifies whether Amazon Lex logs text and audio for a conversation with\n the bot. When you enable conversation logs, text logs store text input,\n transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio\n logs store audio input in Amazon S3.
" + "smithy.api#documentation": "The end-to-end success or failure of the test result evaluation item.
", + "smithy.api#required": {} } }, - "sentimentAnalysisSettings": { - "target": "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings" + "speechTranscriptionResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", + "traits": { + "smithy.api#documentation": "The speech transcription success or failure of the test result evaluation item.
" + } }, - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "intentClassificationResults": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelIntentClassificationResults", "traits": { - "smithy.api#documentation": "The unique identifier of the bot that the alias applies to.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The intent classification of the test result evaluation item.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.lexmodelsv2#TagMap", + "slotResolutionResults": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelSlotResolutionResults", "traits": { - "smithy.api#documentation": "A list of tags to add to the bot alias. You can only add tags when\n you create an alias, you can't use the UpdateBotAlias\n operation to update the tags on a bot alias. To update tags, use the\n TagResource operation.
The slot success or failure of the test result evaluation item.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "The test result evaluation item at the conversation level.
" } }, - "com.amazonaws.lexmodelsv2#CreateBotAliasResponse": { + "com.amazonaws.lexmodelsv2#ConversationLevelTestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelTestResultItem" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLevelTestResults": { "type": "structure", "members": { - "botAliasId": { - "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "items": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelTestResultItemList", "traits": { - "smithy.api#documentation": "The unique identifier of the bot alias.
" + "smithy.api#documentation": "The item list in the test set results data at the conversation level.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The test set results data at the conversation level.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLevelTestResultsFilterBy": { + "type": "structure", + "members": { + "endToEndResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", + "traits": { + "smithy.api#documentation": "The selection of matched or mismatched end-to-end status to filter test set results data\n at the conversation level.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The selection to filter the test set results data at the conversation level.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLogSettings": { + "type": "structure", + "members": { + "textLogSettings": { + "target": "com.amazonaws.lexmodelsv2#TextLogSettingsList", + "traits": { + "smithy.api#documentation": "The Amazon CloudWatch Logs settings for logging text and metadata.
" + } + }, + "audioLogSettings": { + "target": "com.amazonaws.lexmodelsv2#AudioLogSettingsList", + "traits": { + "smithy.api#documentation": "The Amazon S3 settings for logging audio to an S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configures conversation logging that saves audio, text, and metadata\n for the conversations with your users.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLogsDataSource": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The bot Id from the conversation logs.
", + "smithy.api#required": {} + } + }, + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "traits": { + "smithy.api#documentation": "The bot alias Id from the conversation logs.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The locale Id of the conversation log.
", + "smithy.api#required": {} + } + }, + "filter": { + "target": "com.amazonaws.lexmodelsv2#ConversationLogsDataSourceFilterBy", + "traits": { + "smithy.api#documentation": "The filter for the data source of the conversation log.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The data source that uses conversation logs.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLogsDataSourceFilterBy": { + "type": "structure", + "members": { + "startTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The start time for the conversation log.
", + "smithy.api#required": {} + } + }, + "endTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The end time for the conversation log.
", + "smithy.api#required": {} + } + }, + "inputMode": { + "target": "com.amazonaws.lexmodelsv2#ConversationLogsInputModeFilter", + "traits": { + "smithy.api#documentation": "The selection to filter by input mode for the conversation logs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The selected data source to filter the conversation log.
" + } + }, + "com.amazonaws.lexmodelsv2#ConversationLogsInputModeFilter": { + "type": "enum", + "members": { + "Speech": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Speech" + } + }, + "Text": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Text" + } + } + } + }, + "com.amazonaws.lexmodelsv2#Count": { + "type": "integer" + }, + "com.amazonaws.lexmodelsv2#CreateBot": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#CreateBotRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#CreateBotResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an Amazon Lex conversational bot.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#CreateBotAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#CreateBotAliasRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#CreateBotAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an alias for the specified version of a bot. Use an alias to\n enable you to change the version of a bot without updating applications\n that use the bot.
\nFor example, you can create an alias called \"PROD\" that your\n applications use to call the Amazon Lex bot.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botaliases", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#CreateBotAliasRequest": { + "type": "structure", + "members": { + "botAliasName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The alias to create. The name must be unique for the bot.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", + "traits": { + "smithy.api#documentation": "A description of the alias. Use this description to help identify\n the alias.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#NumericalBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that this alias points to. You can use the\n UpdateBotAlias operation to change the\n bot version associated with the alias.
" + } + }, + "botAliasLocaleSettings": { + "target": "com.amazonaws.lexmodelsv2#BotAliasLocaleSettingsMap", + "traits": { + "smithy.api#documentation": "Maps configuration information to a specific locale. You can use\n this parameter to specify a specific Lambda function to run different\n functions in different locales.
" + } + }, + "conversationLogSettings": { + "target": "com.amazonaws.lexmodelsv2#ConversationLogSettings", + "traits": { + "smithy.api#documentation": "Specifies whether Amazon Lex logs text and audio for a conversation with\n the bot. When you enable conversation logs, text logs store text input,\n transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio\n logs store audio input in Amazon S3.
" + } + }, + "sentimentAnalysisSettings": { + "target": "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings" + }, + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that the alias applies to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", + "traits": { + "smithy.api#documentation": "A list of tags to add to the bot alias. You can only add tags when\n you create an alias, you can't use the UpdateBotAlias\n operation to update the tags on a bot alias. To update tags, use the\n TagResource operation.
The unique identifier of the bot alias.
" } }, "botAliasName": { @@ -2634,6 +3031,9 @@ "smithy.api#documentation": "A list of tags associated with the bot alias.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateBotLocale": { @@ -2718,6 +3118,9 @@ "smithy.api#documentation": "The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the\n user.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateBotLocaleResponse": { @@ -2777,6 +3180,9 @@ "smithy.api#documentation": "A timestamp specifying the date and time that the bot locale was\n created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateBotRequest": { @@ -2840,6 +3246,9 @@ "smithy.api#documentation": "The list of bot members in a network to be created.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateBotResponse": { @@ -2917,6 +3326,9 @@ "smithy.api#documentation": "The list of bots in a network that was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateBotVersion": { @@ -2980,6 +3392,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateBotVersionResponse": { @@ -3021,6 +3436,9 @@ "smithy.api#documentation": "A timestamp of the date and time that the version was\n created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateCustomVocabularyItemsList": { @@ -3095,6 +3513,9 @@ "smithy.api#documentation": "An password to use to encrypt the exported archive. Using a password\n is optional, but you should encrypt the archive to protect the data in\n transit between Amazon Lex and your local computer.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateExportResponse": { @@ -3130,6 +3551,9 @@ "smithy.api#documentation": "The date and time that the request to export a bot was\n created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateIntent": { @@ -3250,7 +3674,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with this\n intent.
", + "smithy.api#documentation": "The version of the bot associated with this\n intent.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3269,6 +3693,9 @@ "smithy.api#documentation": "Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateIntentResponse": { @@ -3355,7 +3782,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with the\n intent.
" + "smithy.api#documentation": "The version of the bot associated with the\n intent.
" } }, "localeId": { @@ -3376,6 +3803,9 @@ "smithy.api#documentation": "Configuration settings for the response that is sent to the user at\n the beginning of a conversation, before eliciting slot values.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateResourcePolicy": { @@ -3433,6 +3863,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateResourcePolicyResponse": { @@ -3450,6 +3883,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateResourcePolicyStatement": { @@ -3520,7 +3956,7 @@ "principal": { "target": "com.amazonaws.lexmodelsv2#PrincipalList", "traits": { - "smithy.api#documentation": "An IAM principal, such as an IAM users, IAM roles, or AWS services\n that is allowed or denied access to a resource. For more information,\n see AWS JSON policy elements: Principal.
", + "smithy.api#documentation": "An IAM principal, such as an IAM user, IAM role, \n or Amazon Web Services services\n that is allowed or denied access to a resource. For more information,\n see Amazon Web Services JSON policy elements: Principal.
", "smithy.api#required": {} } }, @@ -3544,6 +3980,9 @@ "smithy.api#httpQuery": "expectedRevisionId" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateResourcePolicyStatementResponse": { @@ -3561,6 +4000,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateSlot": { @@ -3670,7 +4112,7 @@ "multipleValuesSetting": { "target": "com.amazonaws.lexmodelsv2#MultipleValuesSetting", "traits": { - "smithy.api#documentation": "Indicates whether the slot returns multiple values in one response.\n 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 multipleValuesSetting is not set, the default\n value is false.
Indicates whether the slot returns multiple values in one response.\n Multi-value slots are only available in the en-US locale. \n If you set this value to true in any other locale, Amazon Lex throws a\n ValidationException.
If the multipleValuesSetting is not set, the default\n value is false.
Specifications for the constituent sub slots and the \n expression for the composite slot.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateSlotResponse": { @@ -3762,6 +4207,9 @@ "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateSlotType": { @@ -3807,7 +4255,7 @@ "slotTypeName": { "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The name for the slot. A slot type name must be unique within the\n account.
", + "smithy.api#documentation": "The name for the slot. A slot type name must be unique within the\n intent.
", "smithy.api#required": {} } }, @@ -3826,7 +4274,7 @@ "valueSelectionSetting": { "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", "traits": { - "smithy.api#documentation": "Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:
\n\n OriginalValue - Returns the value entered by the\n user, if the user value is similar to the slot value.
\n TopResolution - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.
If you don't specify the valueSelectionSetting\n parameter, the default is OriginalValue.
Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:
\n\n ORIGINAL_VALUE - Returns the value entered by the\n user, if the user value is similar to the slot value.
\n TOP_RESOLUTION - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.
If you don't specify the valueSelectionSetting\n parameter, the default is ORIGINAL_VALUE.
Specifications for a composite slot type.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#CreateSlotTypeResponse": { @@ -3948,6 +4399,101 @@ "smithy.api#documentation": "Specifications for a composite slot type.
" } } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReportRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a report that describes the differences between the bot and the test set.
", + "smithy.api#http": { + "method": "POST", + "uri": "/testsets/{testSetId}/testsetdiscrepancy", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReportRequest": { + "type": "structure", + "members": { + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The test set Id for the test set discrepancy report.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportResourceTarget", + "traits": { + "smithy.api#documentation": "The target bot for the test set discrepancy report.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReportResponse": { + "type": "structure", + "members": { + "testSetDiscrepancyReportId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the test set discrepancy report to describe.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The creation date and time for the test set discrepancy report.
" + } + }, + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The test set Id for the test set discrepancy report.
" + } + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportResourceTarget", + "traits": { + "smithy.api#documentation": "The target bot for the test set discrepancy report.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CreateUploadUrl": { @@ -3986,7 +4532,10 @@ }, "com.amazonaws.lexmodelsv2#CreateUploadUrlRequest": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#input": {} + } }, "com.amazonaws.lexmodelsv2#CreateUploadUrlResponse": { "type": "structure", @@ -4003,6 +4552,9 @@ "smithy.api#documentation": "A pre-signed S3 write URL. Upload the zip archive file that contains\n the definition of your bot or bot locale.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#CustomPayload": { @@ -4093,7 +4645,7 @@ "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.
The identifier of the local to import the custom vocabulary to. The value must\n be en_GB.
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.
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.
A timestamp indicating the start date for the date range\n filter.
", + "smithy.api#documentation": "A timestamp indicating the start date for the date range\n filter.
", "smithy.api#required": {} } }, "endDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "A timestamp indicating the end date for the date range\n filter.
", + "smithy.api#documentation": "A timestamp indicating the end date for the date range\n filter.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The object used for specifying the data range that the customer\n wants Amazon Lex to read through in the input transcripts.
" + "smithy.api#documentation": "The object used for specifying the data range that the customer\n wants Amazon Lex to read through in the input transcripts.
" } }, "com.amazonaws.lexmodelsv2#DefaultConditionalBranch": { @@ -4375,6 +4927,9 @@ "smithy.api#httpQuery": "skipResourceInUseCheck" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteBotAliasResponse": { @@ -4398,6 +4953,9 @@ "smithy.api#documentation": "The current status of the alias. The status is Deleting\n while the alias is in the process of being deleted. Once the alias is\n deleted, it will no longer appear in the list of aliases returned by\n the ListBotAliases operation.
The status of deleting the bot locale. The locale first enters the\n Deleting status. Once the locale is deleted it no\n longer appears in the list of locales for the bot.
The current status of the bot. The status is Deleting\n while the bot and its associated resources are being deleted.
The current status of the bot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteCustomVocabulary": { @@ -4698,6 +5274,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteCustomVocabularyResponse": { @@ -4727,6 +5306,9 @@ "smithy.api#documentation": "The status of removing the custom vocabulary.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteExport": { @@ -4774,6 +5356,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteExportResponse": { @@ -4791,6 +5376,9 @@ "smithy.api#documentation": "The current status of the deletion. When the deletion is complete,\n the export will no longer be returned by the ListExports operation and calls to the \n DescribeExport operation with the export identifier will\n fail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteImport": { @@ -4838,6 +5426,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteImportResponse": { @@ -4855,6 +5446,9 @@ "smithy.api#documentation": "The current status of the deletion. When the deletion is complete,\n the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will\n fail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteIntent": { @@ -4929,6 +5523,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteResourcePolicy": { @@ -4980,6 +5577,9 @@ "smithy.api#httpQuery": "expectedRevisionId" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteResourcePolicyResponse": { @@ -4997,6 +5597,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteResourcePolicyStatement": { @@ -5056,6 +5659,9 @@ "smithy.api#httpQuery": "expectedRevisionId" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteResourcePolicyStatementResponse": { @@ -5073,6 +5679,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DeleteSlot": { @@ -5155,6 +5764,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteSlotType": { @@ -5237,6 +5849,63 @@ "smithy.api#httpQuery": "skipResourceInUseCheck" } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#DeleteTestSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DeleteTestSetRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The action to delete the selected test set.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/testsets/{testSetId}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.lexmodelsv2#DeleteTestSetRequest": { + "type": "structure", + "members": { + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The test set Id of the test set to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteUtterances": { @@ -5292,11 +5961,17 @@ "smithy.api#httpQuery": "sessionId" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DeleteUtterancesResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lexmodelsv2#DescribeBot": { "type": "operation", @@ -5471,6 +6146,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeBotAliasResponse": { @@ -5551,6 +6229,9 @@ "smithy.api#documentation": "A list of the networks to which the bot alias you described belongs.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeBotLocale": { @@ -5761,7 +6442,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#BotVersion", "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with the\n locale.
", + "smithy.api#documentation": "The version of the bot associated with the\n locale.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5774,6 +6455,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeBotLocaleResponse": { @@ -5788,7 +6472,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#BotVersion", "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with the\n locale.
" + "smithy.api#documentation": "The version of the bot associated with the\n locale.
" } }, "localeId": { @@ -5875,6 +6559,9 @@ "smithy.api#documentation": "Recommended actions to take to resolve an error in the\n failureReasons field.
The object representing the URL of the bot definition, the URL of\n the associated transcript and a statistical summary of the bot\n recommendation results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeBotRequest": { @@ -6027,6 +6720,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeBotResponse": { @@ -6104,6 +6800,9 @@ "smithy.api#documentation": "If the botStatus is Failed, this contains\n a list of reasons that the bot couldn't be built.
The members of bot network in the version that was described.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeCustomVocabularyMetadata": { @@ -6349,6 +7054,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeCustomVocabularyMetadataResponse": { @@ -6390,6 +7098,9 @@ "smithy.api#documentation": "The date and time that the custom vocabulary was last updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeExport": { @@ -6472,6 +7183,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeExportResponse": { @@ -6525,6 +7239,9 @@ "smithy.api#documentation": "The last date and time that the export was updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeImport": { @@ -6607,6 +7324,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeImportResponse": { @@ -6666,6 +7386,9 @@ "smithy.api#documentation": "The date and time that the import was last updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeIntent": { @@ -6737,6 +7460,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeIntentResponse": { @@ -6853,9 +7579,12 @@ "initialResponseSetting": { "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeResourcePolicy": { @@ -6897,6 +7626,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeResourcePolicyResponse": { @@ -6920,6 +7652,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeSlot": { @@ -6999,6 +7734,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeSlotResponse": { @@ -7088,6 +7826,9 @@ "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#DescribeSlotType": { @@ -7159,6 +7900,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#DescribeSlotTypeResponse": { @@ -7239,847 +7983,785 @@ "smithy.api#documentation": "Specifications for a composite slot type.
" } } - } - }, - "com.amazonaws.lexmodelsv2#Description": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#DialogAction": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.lexmodelsv2#DialogActionType", - "traits": { - "smithy.api#documentation": "The action that the bot should execute.
", - "smithy.api#required": {} - } + "com.amazonaws.lexmodelsv2#DescribeTestExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestExecutionRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, - "slotToElicit": { - "target": "com.amazonaws.lexmodelsv2#Name", - "traits": { - "smithy.api#documentation": "If the dialog action is ElicitSlot, defines the slot to\n elicit from the user.
Gets metadata information about the test execution.
", + "smithy.api#http": { + "method": "GET", + "uri": "/testexecutions/{testExecutionId}", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#DescribeTestExecutionRequest": { + "type": "structure", + "members": { + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "When true the next message for the intent is not used.
" + "smithy.api#documentation": "The execution Id of the test set execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Defines the action that the bot executes at runtime when the\n conversation reaches this step.
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#DialogActionType": { - "type": "enum", + "com.amazonaws.lexmodelsv2#DescribeTestExecutionResponse": { + "type": "structure", "members": { - "ElicitIntent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ElicitIntent" - } - }, - "StartIntent": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartIntent" - } - }, - "ElicitSlot": { - "target": "smithy.api#Unit", + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#enumValue": "ElicitSlot" + "smithy.api#documentation": "The execution Id for the test set execution.
" } }, - "EvaluateConditional": { - "target": "smithy.api#Unit", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#enumValue": "EvaluateConditional" + "smithy.api#documentation": "The execution creation date and time for the test set execution.
" } }, - "InvokeDialogCodeHook": { - "target": "smithy.api#Unit", + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#enumValue": "InvokeDialogCodeHook" + "smithy.api#documentation": "The date and time of the last update for the execution.
" } }, - "ConfirmIntent": { - "target": "smithy.api#Unit", + "testExecutionStatus": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionStatus", "traits": { - "smithy.api#enumValue": "ConfirmIntent" + "smithy.api#documentation": "The test execution status for the test execution.
" } }, - "FulfillIntent": { - "target": "smithy.api#Unit", + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#enumValue": "FulfillIntent" + "smithy.api#documentation": "The test set Id for the test set execution.
" } }, - "CloseIntent": { - "target": "smithy.api#Unit", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#enumValue": "CloseIntent" + "smithy.api#documentation": "The test set name of the test set execution.
" } }, - "EndConversation": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EndConversation" - } - } - } - }, - "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting": { - "type": "structure", - "members": { - "enableCodeHookInvocation": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "target": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionTarget", "traits": { - "smithy.api#documentation": "Indicates whether a Lambda function should be invoked\n for the dialog.
", - "smithy.api#required": {} + "smithy.api#documentation": "The target bot for the test set execution details.
" } }, - "active": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "apiMode": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionApiMode", "traits": { - "smithy.api#documentation": "Determines whether a dialog code hook is used when the intent is\n activated.
", - "smithy.api#required": {} + "smithy.api#documentation": "Indicates whether we use streaming or non-streaming APIs are used for \n the test set execution. For streaming, StartConversation \n Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance \n and RecognizeText Amazon Lex Runtime API is used.
A label that indicates the dialog step from which the dialog code\n hook is happening.
" + "smithy.api#documentation": "Indicates whether test set is audio or text.
" } }, - "postCodeHookSpecification": { - "target": "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification", + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", "traits": { - "smithy.api#documentation": "Contains the responses and actions that Amazon Lex takes\n after the Lambda function is complete.
", - "smithy.api#required": {} + "smithy.api#documentation": "Reasons for the failure of the test set execution.
" } } }, "traits": { - "smithy.api#documentation": "Settings that specify the dialog code hook that is\n called by Amazon Lex at a step of the conversation.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#DialogCodeHookSettings": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.lexmodelsv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Enables the dialog code hook so that it processes user\n requests.
", - "smithy.api#required": {} - } - } + "com.amazonaws.lexmodelsv2#DescribeTestSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetRequest" }, - "traits": { - "smithy.api#documentation": "Settings that determine the Lambda function that Amazon Lex uses for\n processing user responses.
" - } - }, - "com.amazonaws.lexmodelsv2#DialogState": { - "type": "structure", - "members": { - "dialogAction": { - "target": "com.amazonaws.lexmodelsv2#DialogAction" + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, - "intent": { - "target": "com.amazonaws.lexmodelsv2#IntentOverride" + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" }, - "sessionAttributes": { - "target": "com.amazonaws.lexmodelsv2#StringMap", - "traits": { - "smithy.api#documentation": "Map of key/value pairs representing session-specific context\n information. It contains application information passed between Amazon Lex and a client application.
" - } + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" } - }, + ], "traits": { - "smithy.api#documentation": "The current state of the conversation with the user.
" + "smithy.api#documentation": "Gets metadata information about the test set.
", + "smithy.api#http": { + "method": "GET", + "uri": "/testsets/{testSetId}", + "code": 200 + } } }, - "com.amazonaws.lexmodelsv2#DraftBotVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 5 + "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReport": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReportRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, - "smithy.api#pattern": "^DRAFT$" - } - }, - "com.amazonaws.lexmodelsv2#Effect": { - "type": "enum", - "members": { - "Allow": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Allow" - } + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" }, - "Deny": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Deny" - } + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets metadata information about the test set discrepancy report.
", + "smithy.api#http": { + "method": "GET", + "uri": "/testsetdiscrepancy/{testSetDiscrepancyReportId}", + "code": 200 } } }, - "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting": { + "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReportRequest": { "type": "structure", "members": { - "enableCodeHookInvocation": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "testSetDiscrepancyReportId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "Indicates whether a Lambda function should be invoked\n for the dialog.
", + "smithy.api#documentation": "The unique identifier of the test set discrepancy report.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "invocationLabel": { - "target": "com.amazonaws.lexmodelsv2#Name", - "traits": { - "smithy.api#documentation": "A label that indicates the dialog step from which the dialog code\n hook is happening.
" - } } }, "traits": { - "smithy.api#documentation": "Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#EncryptionSetting": { + "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReportResponse": { "type": "structure", "members": { - "kmsKeyArn": { - "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "testSetDiscrepancyReportId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The KMS key ARN used to encrypt the metadata associated with the bot\n recommendation.
" + "smithy.api#documentation": "The unique identifier of the test set discrepancy report to describe.
" } }, - "botLocaleExportPassword": { - "target": "com.amazonaws.lexmodelsv2#FilePassword", + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The password used to encrypt the recommended bot recommendation\n file.
" + "smithy.api#documentation": "The test set Id for the test set discrepancy report.
" } }, - "associatedTranscriptsPassword": { - "target": "com.amazonaws.lexmodelsv2#FilePassword", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The password used to encrypt the associated transcript file.
" + "smithy.api#documentation": "The time and date of creation for the test set discrepancy report.
" } - } - }, - "traits": { - "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation, as well as the KMS key ARN used\n to encrypt the associated metadata.
" - } - }, - "com.amazonaws.lexmodelsv2#ErrorCode": { - "type": "enum", - "members": { - "DUPLICATE_INPUT": { - "target": "smithy.api#Unit", + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportResourceTarget", "traits": { - "smithy.api#enumValue": "DUPLICATE_INPUT" + "smithy.api#documentation": "The target bot location for the test set discrepancy report.
" } }, - "RESOURCE_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", + "testSetDiscrepancyReportStatus": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportStatus", "traits": { - "smithy.api#enumValue": "RESOURCE_DOES_NOT_EXIST" + "smithy.api#documentation": "The status for the test set discrepancy report.
" } }, - "RESOURCE_ALREADY_EXISTS": { - "target": "smithy.api#Unit", + "lastUpdatedDataTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#enumValue": "RESOURCE_ALREADY_EXISTS" + "smithy.api#documentation": "The date and time of the last update for the test set discrepancy report.
" } }, - "INTERNAL_SERVER_FAILURE": { - "target": "smithy.api#Unit", + "testSetDiscrepancyTopErrors": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyErrors", "traits": { - "smithy.api#enumValue": "INTERNAL_SERVER_FAILURE" + "smithy.api#documentation": "The top 200 error results from the test set discrepancy report.
" + } + }, + "testSetDiscrepancyRawOutputUrl": { + "target": "com.amazonaws.lexmodelsv2#PresignedS3Url", + "traits": { + "smithy.api#documentation": "Pre-signed Amazon S3 URL to download the test set discrepancy report.
" + } + }, + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", + "traits": { + "smithy.api#documentation": "The failure report for the test set discrepancy report generation action.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#ExceptionMessage": { - "type": "string" + "com.amazonaws.lexmodelsv2#DescribeTestSetGeneration": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetGenerationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetGenerationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets metadata information about the test set generation.
", + "smithy.api#http": { + "method": "GET", + "uri": "/testsetgenerations/{testSetGenerationId}", + "code": 200 + } + } }, - "com.amazonaws.lexmodelsv2#ExportFilter": { + "com.amazonaws.lexmodelsv2#DescribeTestSetGenerationRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelsv2#ExportFilterName", - "traits": { - "smithy.api#documentation": "The name of the field to use for filtering.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.lexmodelsv2#FilterValues", - "traits": { - "smithy.api#documentation": "The values to use to filter the response. The values must be\n Bot, BotLocale, or\n CustomVocabulary.
The operator to use for the filter. Specify EQ when the\n ListExports operation should return only resource types\n that equal the specified value. Specify CO when the\n ListExports operation should return resource types that\n contain the specified value.
The unique identifier of the test set generation.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Filters the response form the ListExports operation
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ExportFilterName": { - "type": "enum", + "com.amazonaws.lexmodelsv2#DescribeTestSetGenerationResponse": { + "type": "structure", "members": { - "ExportResourceType": { - "target": "smithy.api#Unit", + "testSetGenerationId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#enumValue": "ExportResourceType" + "smithy.api#documentation": "The unique identifier of the test set generation.
" } - } - } - }, - "com.amazonaws.lexmodelsv2#ExportFilterOperator": { - "type": "enum", - "members": { - "Contains": { - "target": "smithy.api#Unit", + }, + "testSetGenerationStatus": { + "target": "com.amazonaws.lexmodelsv2#TestSetGenerationStatus", "traits": { - "smithy.api#enumValue": "CO" + "smithy.api#documentation": "The status for the test set generation.
" } }, - "Equals": { - "target": "smithy.api#Unit", + "failureReasons": { + "target": "com.amazonaws.lexmodelsv2#FailureReasons", "traits": { - "smithy.api#enumValue": "EQ" + "smithy.api#documentation": "The reasons the test set generation failed.
" } - } - } - }, - "com.amazonaws.lexmodelsv2#ExportFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#ExportFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.lexmodelsv2#ExportResourceSpecification": { - "type": "structure", - "members": { - "botExportSpecification": { - "target": "com.amazonaws.lexmodelsv2#BotExportSpecification", + }, + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "Parameters for exporting a bot.
" + "smithy.api#documentation": "The unique identifier for the test set created for the generated test set.
" } }, - "botLocaleExportSpecification": { - "target": "com.amazonaws.lexmodelsv2#BotLocaleExportSpecification", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "Parameters for exporting a bot locale.
" + "smithy.api#documentation": "The test set name for the generated test set.
" } }, - "customVocabularyExportSpecification": { - "target": "com.amazonaws.lexmodelsv2#CustomVocabularyExportSpecification", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The parameters required to export a custom vocabulary.
" + "smithy.api#documentation": "The test set description for the test set generation.
" } - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the bot or bot locale that you want to\n export. You can specify the botExportSpecification or the\n botLocaleExportSpecification, but not both.
The Amazon S3 storage location for the test set generation.
" + } + }, + "generationDataSource": { + "target": "com.amazonaws.lexmodelsv2#TestSetGenerationDataSource", + "traits": { + "smithy.api#documentation": "The data source of the test set used for the test set generation.
" + } + }, + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", + "traits": { + "smithy.api#documentation": "The roleARN of the test set used for the test set generation.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The creation date and time for the test set generation.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time of the last update for the test set generation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ExportSortBy": { + "com.amazonaws.lexmodelsv2#DescribeTestSetRequest": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.lexmodelsv2#ExportSortAttribute", - "traits": { - "smithy.api#documentation": "The export field to use for sorting.
", - "smithy.api#required": {} - } - }, - "order": { - "target": "com.amazonaws.lexmodelsv2#SortOrder", + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The order to sort the list.
", + "smithy.api#documentation": "The test set Id for the test set request.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides information about sorting a list of exports.
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ExportStatus": { - "type": "enum", + "com.amazonaws.lexmodelsv2#DescribeTestSetResponse": { + "type": "structure", "members": { - "InProgress": { - "target": "smithy.api#Unit", + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#enumValue": "InProgress" + "smithy.api#documentation": "The test set Id for the test set response.
" } }, - "Completed": { - "target": "smithy.api#Unit", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#enumValue": "Completed" + "smithy.api#documentation": "The test set name of the test set.
" } }, - "Failed": { - "target": "smithy.api#Unit", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#enumValue": "Failed" + "smithy.api#documentation": "The description of the test set.
" } }, - "Deleting": { - "target": "smithy.api#Unit", + "modality": { + "target": "com.amazonaws.lexmodelsv2#TestSetModality", "traits": { - "smithy.api#enumValue": "Deleting" + "smithy.api#documentation": "Indicates whether the test set is audio or text data.
" } - } - } - }, - "com.amazonaws.lexmodelsv2#ExportSummary": { - "type": "structure", - "members": { - "exportId": { - "target": "com.amazonaws.lexmodelsv2#Id", + }, + "status": { + "target": "com.amazonaws.lexmodelsv2#TestSetStatus", "traits": { - "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the export.
" + "smithy.api#documentation": "The status of the test set.
" } }, - "resourceSpecification": { - "target": "com.amazonaws.lexmodelsv2#ExportResourceSpecification", + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", "traits": { - "smithy.api#documentation": "Information about the bot or bot locale that was exported.
" + "smithy.api#documentation": "The roleARN used for any operation in the test set to access \n resources in the Amazon Web Services account.
" } }, - "fileFormat": { - "target": "com.amazonaws.lexmodelsv2#ImportExportFileFormat", + "numTurns": { + "target": "com.amazonaws.lexmodelsv2#Count", "traits": { - "smithy.api#documentation": "The file format used in the export files.
" + "smithy.api#documentation": "The total number of agent and user turn in the test set.
" } }, - "exportStatus": { - "target": "com.amazonaws.lexmodelsv2#ExportStatus", + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", "traits": { - "smithy.api#documentation": "The status of the export. When the status is Completed\n the export is ready to download.
The Amazon S3 storage location for the test set data.
" } }, "creationDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the export was created.
" + "smithy.api#documentation": "The creation date and time for the test set data.
" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the export was last updated.
" + "smithy.api#documentation": "The date and time for the last update of the test set data.
" } } }, "traits": { - "smithy.api#documentation": "Provides summary information about an export in an export list.\n
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ExportSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#ExportSummary" + "com.amazonaws.lexmodelsv2#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, - "com.amazonaws.lexmodelsv2#ExternalSourceSetting": { + "com.amazonaws.lexmodelsv2#DialogAction": { "type": "structure", "members": { - "grammarSlotTypeSetting": { - "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting", + "type": { + "target": "com.amazonaws.lexmodelsv2#DialogActionType", + "traits": { + "smithy.api#documentation": "The action that the bot should execute.
", + "smithy.api#required": {} + } + }, + "slotToElicit": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "If the dialog action is ElicitSlot, defines the slot to\n elicit from the user.
Settings required for a slot type based on a grammar that you\n provide.
" + "smithy.api#documentation": "When true the next message for the intent is not used.
" } } }, "traits": { - "smithy.api#documentation": "Provides information about the external source of the slot type's\n definition.
" + "smithy.api#documentation": "Defines the action that the bot executes at runtime when the\n conversation reaches this step.
" } }, - "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItem": { - "type": "structure", + "com.amazonaws.lexmodelsv2#DialogActionType": { + "type": "enum", "members": { - "itemId": { - "target": "com.amazonaws.lexmodelsv2#ItemId", + "ElicitIntent": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique item identifer for the failed custom vocabulary item \n from the custom vocabulary list.
" + "smithy.api#enumValue": "ElicitIntent" } }, - "errorMessage": { - "target": "com.amazonaws.lexmodelsv2#ErrorMessage", + "StartIntent": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The error message for the failed custom vocabulary item \n from the custom vocabulary list.
" + "smithy.api#enumValue": "StartIntent" } }, - "errorCode": { - "target": "com.amazonaws.lexmodelsv2#ErrorCode", + "ElicitSlot": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique error code for the failed custom vocabulary item \n from the custom vocabulary list.
" + "smithy.api#enumValue": "ElicitSlot" } - } - }, - "traits": { - "smithy.api#documentation": "The unique failed custom vocabulary item from the custom \n vocabulary list.
" - } - }, - "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItems": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItem" - } - }, - "com.amazonaws.lexmodelsv2#FailureReason": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#FailureReasons": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#FailureReason" - } - }, - "com.amazonaws.lexmodelsv2#FilePassword": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.lexmodelsv2#FilterValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 + "EvaluateConditional": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EvaluateConditional" + } }, - "smithy.api#pattern": "^[0-9a-zA-Z_()\\s-]+$" - } - }, - "com.amazonaws.lexmodelsv2#FilterValues": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#FilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.lexmodelsv2#FulfillmentCodeHookSettings": { - "type": "structure", - "members": { - "enabled": { - "target": "com.amazonaws.lexmodelsv2#Boolean", + "InvokeDialogCodeHook": { + "target": "smithy.api#Unit", "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": {} + "smithy.api#enumValue": "InvokeDialogCodeHook" } }, - "postFulfillmentStatusSpecification": { - "target": "com.amazonaws.lexmodelsv2#PostFulfillmentStatusSpecification", + "ConfirmIntent": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides settings for messages sent to the user for after the Lambda\n fulfillment function completes. Post-fulfillment messages can be sent\n for both streaming and non-streaming conversations.
" + "smithy.api#enumValue": "ConfirmIntent" } }, - "fulfillmentUpdatesSpecification": { - "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdatesSpecification", + "FulfillIntent": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides settings for update messages sent to the user for\n long-running Lambda fulfillment functions. Fulfillment updates can be\n used only with streaming conversations.
" + "smithy.api#enumValue": "FulfillIntent" } }, - "active": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "CloseIntent": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Determines whether the fulfillment code hook is used. When\n active is false, the code hook doesn't run.
Determines if a Lambda function should be invoked for a specific\n intent.
" - } - }, - "com.amazonaws.lexmodelsv2#FulfillmentStartResponseDelay": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 900 } } }, - "com.amazonaws.lexmodelsv2#FulfillmentStartResponseSpecification": { + "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting": { "type": "structure", "members": { - "delayInSeconds": { - "target": "com.amazonaws.lexmodelsv2#FulfillmentStartResponseDelay", + "enableCodeHookInvocation": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "The delay between when the Lambda fulfillment function starts running\n and the start message is played. If the Lambda function returns before\n the delay is over, the start message isn't played.
", + "smithy.api#documentation": "Indicates whether a Lambda function should be invoked\n for the dialog.
", "smithy.api#required": {} } }, - "messageGroups": { - "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "One to 5 message groups that contain start messages. Amazon Lex chooses\n one of the messages to play to the user.
", + "smithy.api#documentation": "Determines whether a dialog code hook is used when the intent is\n activated.
", "smithy.api#required": {} } }, - "allowInterrupt": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "invocationLabel": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "Determines whether the user can interrupt the start message while it\n is playing.
" + "smithy.api#documentation": "A label that indicates the dialog step from which the dialog code\n hook is happening.
" + } + }, + "postCodeHookSpecification": { + "target": "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification", + "traits": { + "smithy.api#documentation": "Contains the responses and actions that Amazon Lex takes\n after the Lambda function is complete.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides settings for a message that is sent to the user when a\n fulfillment Lambda function starts running.
" - } - }, - "com.amazonaws.lexmodelsv2#FulfillmentTimeout": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 900 - } - } - }, - "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseFrequency": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 900 - } + "smithy.api#documentation": "Settings that specify the dialog code hook that is\n called by Amazon Lex at a step of the conversation.
" } }, - "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseSpecification": { + "com.amazonaws.lexmodelsv2#DialogCodeHookSettings": { "type": "structure", "members": { - "frequencyInSeconds": { - "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseFrequency", - "traits": { - "smithy.api#documentation": "The frequency that a message is sent to the user. When the period\n ends, Amazon Lex chooses a message from the message groups and plays it to\n the user. If the fulfillment Lambda returns before the first period\n ends, an update message is not played to the user.
", - "smithy.api#required": {} - } - }, - "messageGroups": { - "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", + "enabled": { + "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { - "smithy.api#documentation": "One to 5 message groups that contain update messages. Amazon Lex chooses\n one of the messages to play to the user.
", + "smithy.api#default": false, + "smithy.api#documentation": "Enables the dialog code hook so that it processes user\n requests.
", "smithy.api#required": {} } - }, - "allowInterrupt": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Determines whether the user can interrupt an update message while it\n is playing.
" - } } }, "traits": { - "smithy.api#documentation": "Provides settings for a message that is sent periodically to the\n user while a fulfillment Lambda function is running.
" + "smithy.api#documentation": "Settings that determine the Lambda function that Amazon Lex uses for\n processing user responses.
" } }, - "com.amazonaws.lexmodelsv2#FulfillmentUpdatesSpecification": { + "com.amazonaws.lexmodelsv2#DialogState": { "type": "structure", "members": { - "active": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Determines whether fulfillment updates are sent to the user. When\n this field is true, updates are sent.
\nIf the active field is set to true, the\n startResponse, updateResponse, and\n timeoutInSeconds fields are required.
Provides configuration information for the message sent to users\n when the fulfillment Lambda functions starts running.
" + "smithy.api#documentation": "Map of key/value pairs representing session-specific context\n information. It contains application information passed between Amazon Lex and a client application.
" } + } + }, + "traits": { + "smithy.api#documentation": "The current state of the conversation with the user.
" + } + }, + "com.amazonaws.lexmodelsv2#DraftBotVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 5 }, - "updateResponse": { - "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseSpecification", + "smithy.api#pattern": "^DRAFT$" + } + }, + "com.amazonaws.lexmodelsv2#Effect": { + "type": "enum", + "members": { + "Allow": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides configuration information for messages sent periodically to\n the user while the fulfillment Lambda function is running.
" + "smithy.api#enumValue": "Allow" } }, - "timeoutInSeconds": { - "target": "com.amazonaws.lexmodelsv2#FulfillmentTimeout", + "Deny": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The length of time that the fulfillment Lambda function should run\n before it times out.
" + "smithy.api#enumValue": "Deny" } } - }, - "traits": { - "smithy.api#documentation": "Provides information for updating the user on the progress of\n fulfilling an intent.
" } }, - "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting": { + "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting": { "type": "structure", "members": { - "source": { - "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource", + "enableCodeHookInvocation": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "The source of the grammar used to create the slot type.
" + "smithy.api#documentation": "Indicates whether a Lambda function should be invoked\n for the dialog.
", + "smithy.api#required": {} + } + }, + "invocationLabel": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "A label that indicates the dialog step from which the dialog code\n hook is happening.
" } } }, "traits": { - "smithy.api#documentation": "Settings requried for a slot type based on a grammar that you\n provide.
" + "smithy.api#documentation": "Settings that specify the dialog code hook that is called by Amazon Lex between eliciting slot values.
" } }, - "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource": { + "com.amazonaws.lexmodelsv2#EncryptionSetting": { "type": "structure", "members": { - "s3BucketName": { - "target": "com.amazonaws.lexmodelsv2#S3BucketName", + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", "traits": { - "smithy.api#documentation": "The name of the S3 bucket that contains the grammar source.
", - "smithy.api#required": {} + "smithy.api#documentation": "The KMS key ARN used to encrypt the metadata associated with the bot\n recommendation.
" } }, - "s3ObjectKey": { - "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", + "botLocaleExportPassword": { + "target": "com.amazonaws.lexmodelsv2#FilePassword", "traits": { - "smithy.api#documentation": "The path to the grammar in the S3 bucket.
", - "smithy.api#required": {} + "smithy.api#documentation": "The password used to encrypt the recommended bot recommendation\n file.
" } }, - "kmsKeyArn": { - "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "associatedTranscriptsPassword": { + "target": "com.amazonaws.lexmodelsv2#FilePassword", "traits": { - "smithy.api#documentation": "The Amazon KMS key required to decrypt the contents of the grammar,\n if any.
" + "smithy.api#documentation": "The password used to encrypt the associated transcript file.
" } } }, "traits": { - "smithy.api#documentation": "Describes the Amazon S3 bucket name and location for the grammar\n that is the source for the slot type.
" + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation, as well as the KMS key ARN used\n to encrypt the associated metadata.
" } }, - "com.amazonaws.lexmodelsv2#HitCount": { - "type": "integer" - }, - "com.amazonaws.lexmodelsv2#Id": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 10, - "max": 10 - }, - "smithy.api#pattern": "^[0-9a-zA-Z]+$" - } - }, - "com.amazonaws.lexmodelsv2#ImageResponseCard": { - "type": "structure", + "com.amazonaws.lexmodelsv2#ErrorCode": { + "type": "enum", "members": { - "title": { - "target": "com.amazonaws.lexmodelsv2#AttachmentTitle", + "DUPLICATE_INPUT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The title to display on the response card. The format of the title\n is determined by the platform displaying the response card.
", - "smithy.api#required": {} + "smithy.api#enumValue": "DUPLICATE_INPUT" } }, - "subtitle": { - "target": "com.amazonaws.lexmodelsv2#AttachmentTitle", + "RESOURCE_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The subtitle to display on the response card. The format of the\n subtitle is determined by the platform displaying the response\n card.
" + "smithy.api#enumValue": "RESOURCE_DOES_NOT_EXIST" } }, - "imageUrl": { - "target": "com.amazonaws.lexmodelsv2#AttachmentUrl", + "RESOURCE_ALREADY_EXISTS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The URL of an image to display on the response card. The image URL\n must be publicly available so that the platform displaying the response\n card has access to the image.
" + "smithy.api#enumValue": "RESOURCE_ALREADY_EXISTS" } }, - "buttons": { - "target": "com.amazonaws.lexmodelsv2#ButtonsList", + "INTERNAL_SERVER_FAILURE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of buttons that should be displayed on the response card. The\n arrangement of the buttons is determined by the platform that displays\n the button.
" + "smithy.api#enumValue": "INTERNAL_SERVER_FAILURE" } } - }, - "traits": { - "smithy.api#documentation": "A card that is shown to the user by a messaging platform. You define\n the contents of the card, the card is displayed by the platform.
\nWhen you use a response card, the response from the user is\n constrained to the text associated with a button on the card.
" } }, - "com.amazonaws.lexmodelsv2#ImportExportFileFormat": { - "type": "enum", + "com.amazonaws.lexmodelsv2#ErrorMessage": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#ExceptionMessage": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#ExecutionErrorDetails": { + "type": "structure", "members": { - "LexJson": { - "target": "smithy.api#Unit", + "errorCode": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString", "traits": { - "smithy.api#enumValue": "LexJson" + "smithy.api#documentation": "The error code for the error.
", + "smithy.api#required": {} } }, - "TSV": { - "target": "smithy.api#Unit", + "errorMessage": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString", "traits": { - "smithy.api#enumValue": "TSV" + "smithy.api#documentation": "The message describing the error.
", + "smithy.api#required": {} } } - } - }, - "com.amazonaws.lexmodelsv2#ImportExportFilePassword": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#sensitive": {} + "smithy.api#documentation": "Details about an error in an execution of a test set.
" } }, - "com.amazonaws.lexmodelsv2#ImportFilter": { + "com.amazonaws.lexmodelsv2#ExportFilter": { "type": "structure", "members": { "name": { - "target": "com.amazonaws.lexmodelsv2#ImportFilterName", + "target": "com.amazonaws.lexmodelsv2#ExportFilterName", "traits": { "smithy.api#documentation": "The name of the field to use for filtering.
", "smithy.api#required": {} @@ -8088,34 +8770,34 @@ "values": { "target": "com.amazonaws.lexmodelsv2#FilterValues", "traits": { - "smithy.api#documentation": "The values to use to filter the response. The values must be\n Bot, BotLocale, or\n CustomVocabulary.
The values to use to filter the response. The values must be\n Bot, BotLocale, or\n CustomVocabulary.
The operator to use for the filter. Specify EQ when the\n ListImports operation should return only resource types\n that equal the specified value. Specify CO when the\n ListImports operation should return resource types that\n contain the specified value.
The operator to use for the filter. Specify EQ when the\n ListExports operation should return only resource types\n that equal the specified value. Specify CO when the\n ListExports operation should return resource types that\n contain the specified value.
Filters the response from the ListImports operation.
" + "smithy.api#documentation": "Filters the response form the ListExports operation
" } }, - "com.amazonaws.lexmodelsv2#ImportFilterName": { + "com.amazonaws.lexmodelsv2#ExportFilterName": { "type": "enum", "members": { - "ImportResourceType": { + "ExportResourceType": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ImportResourceType" + "smithy.api#enumValue": "ExportResourceType" } } } }, - "com.amazonaws.lexmodelsv2#ImportFilterOperator": { + "com.amazonaws.lexmodelsv2#ExportFilterOperator": { "type": "enum", "members": { "Contains": { @@ -8132,10 +8814,10 @@ } } }, - "com.amazonaws.lexmodelsv2#ImportFilters": { + "com.amazonaws.lexmodelsv2#ExportFilters": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#ImportFilter" + "target": "com.amazonaws.lexmodelsv2#ExportFilter" }, "traits": { "smithy.api#length": { @@ -8144,53 +8826,39 @@ } } }, - "com.amazonaws.lexmodelsv2#ImportResourceSpecification": { + "com.amazonaws.lexmodelsv2#ExportResourceSpecification": { "type": "structure", "members": { - "botImportSpecification": { - "target": "com.amazonaws.lexmodelsv2#BotImportSpecification", - "traits": { - "smithy.api#documentation": "Parameters for importing a bot.
" - } - }, - "botLocaleImportSpecification": { - "target": "com.amazonaws.lexmodelsv2#BotLocaleImportSpecification", + "botExportSpecification": { + "target": "com.amazonaws.lexmodelsv2#BotExportSpecification", "traits": { - "smithy.api#documentation": "Parameters for importing a bot locale.
" + "smithy.api#documentation": "Parameters for exporting a bot.
" } }, - "customVocabularyImportSpecification": { - "target": "com.amazonaws.lexmodelsv2#CustomVocabularyImportSpecification" - } - }, - "traits": { - "smithy.api#documentation": "Provides information about the bot or bot locale that you want to\n import. You can specify the botImportSpecification or the\n botLocaleImportSpecification, but not both.
Parameters for exporting a bot locale.
" } }, - "BotLocale": { - "target": "smithy.api#Unit", + "customVocabularyExportSpecification": { + "target": "com.amazonaws.lexmodelsv2#CustomVocabularyExportSpecification", "traits": { - "smithy.api#enumValue": "BotLocale" + "smithy.api#documentation": "The parameters required to export a custom vocabulary.
" } }, - "CustomVocabulary": { - "target": "smithy.api#Unit", + "testSetExportSpecification": { + "target": "com.amazonaws.lexmodelsv2#TestSetExportSpecification", "traits": { - "smithy.api#enumValue": "CustomVocabulary" + "smithy.api#documentation": "Specifications for the test set that is exported as a resource.
" } } + }, + "traits": { + "smithy.api#documentation": "Provides information about the bot or bot locale that you want to\n export. You can specify the botExportSpecification or the\n botLocaleExportSpecification, but not both.
The export field to use for sorting.
", "smithy.api#required": {} @@ -8220,10 +8888,10 @@ } }, "traits": { - "smithy.api#documentation": "Provides information for sorting a list of imports.
" + "smithy.api#documentation": "Provides information about sorting a list of exports.
" } }, - "com.amazonaws.lexmodelsv2#ImportStatus": { + "com.amazonaws.lexmodelsv2#ExportStatus": { "type": "enum", "members": { "InProgress": { @@ -8252,745 +8920,1607 @@ } } }, - "com.amazonaws.lexmodelsv2#ImportSummary": { + "com.amazonaws.lexmodelsv2#ExportSummary": { "type": "structure", "members": { - "importId": { + "exportId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the import.
" - } - }, - "importedResourceId": { - "target": "com.amazonaws.lexmodelsv2#ImportedResourceId", - "traits": { - "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the imported\n resource.
" + "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the export.
" } }, - "importedResourceName": { - "target": "com.amazonaws.lexmodelsv2#Name", + "resourceSpecification": { + "target": "com.amazonaws.lexmodelsv2#ExportResourceSpecification", "traits": { - "smithy.api#documentation": "The name that you gave the imported resource.
" + "smithy.api#documentation": "Information about the bot or bot locale that was exported.
" } }, - "importStatus": { - "target": "com.amazonaws.lexmodelsv2#ImportStatus", + "fileFormat": { + "target": "com.amazonaws.lexmodelsv2#ImportExportFileFormat", "traits": { - "smithy.api#documentation": "The status of the resource. When the status is\n Completed the resource is ready to build.
The file format used in the export files.
" } }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelsv2#MergeStrategy", + "exportStatus": { + "target": "com.amazonaws.lexmodelsv2#ExportStatus", "traits": { - "smithy.api#documentation": "The strategy used to merge existing bot or bot locale definitions\n with the imported definition.
" + "smithy.api#documentation": "The status of the export. When the status is Completed\n the export is ready to download.
The date and time that the import was created.
" + "smithy.api#documentation": "The date and time that the export was created.
" } }, "lastUpdatedDateTime": { "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the import was last updated.
" - } - }, - "importedResourceType": { - "target": "com.amazonaws.lexmodelsv2#ImportResourceType", - "traits": { - "smithy.api#documentation": "The type of resource that was imported.
" + "smithy.api#documentation": "The date and time that the export was last updated.
" } } }, "traits": { - "smithy.api#documentation": "Provides summary information about an import in an import\n list.
" + "smithy.api#documentation": "Provides summary information about an export in an export list.\n
" } }, - "com.amazonaws.lexmodelsv2#ImportSummaryList": { + "com.amazonaws.lexmodelsv2#ExportSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#ImportSummary" - } - }, - "com.amazonaws.lexmodelsv2#ImportedResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 10 - }, - "smithy.api#pattern": "^([0-9a-zA-Z_])+$" + "target": "com.amazonaws.lexmodelsv2#ExportSummary" } }, - "com.amazonaws.lexmodelsv2#InitialResponseSetting": { + "com.amazonaws.lexmodelsv2#ExternalSourceSetting": { "type": "structure", "members": { - "initialResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "nextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "grammarSlotTypeSetting": { + "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting", "traits": { - "smithy.api#documentation": "The next step in the conversation.
" + "smithy.api#documentation": "Settings required for a slot type based on a grammar that you provide.
" } - }, - "conditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" - }, - "codeHook": { - "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting" } }, "traits": { - "smithy.api#documentation": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
" + "smithy.api#documentation": "Provides information about the external source of the slot type's definition.
" } }, - "com.amazonaws.lexmodelsv2#InputContext": { + "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItem": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelsv2#Name", + "itemId": { + "target": "com.amazonaws.lexmodelsv2#ItemId", "traits": { - "smithy.api#documentation": "The name of the context.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique item identifer for the failed custom vocabulary item \n from the custom vocabulary list.
" + } + }, + "errorMessage": { + "target": "com.amazonaws.lexmodelsv2#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message for the failed custom vocabulary item \n from the custom vocabulary list.
" + } + }, + "errorCode": { + "target": "com.amazonaws.lexmodelsv2#ErrorCode", + "traits": { + "smithy.api#documentation": "The unique error code for the failed custom vocabulary item \n from the custom vocabulary list.
" } } }, "traits": { - "smithy.api#documentation": "The name of a context that must be active for an intent to be\n selected by Amazon Lex.
" + "smithy.api#documentation": "The unique failed custom vocabulary item from the custom \n vocabulary list.
" } }, - "com.amazonaws.lexmodelsv2#InputContextsList": { + "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItems": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#InputContext" - }, + "target": "com.amazonaws.lexmodelsv2#FailedCustomVocabularyItem" + } + }, + "com.amazonaws.lexmodelsv2#FailureReason": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#FailureReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#FailureReason" + } + }, + "com.amazonaws.lexmodelsv2#FilePassword": { + "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 5 - } + "max": 1024 + }, + "smithy.api#sensitive": {} } }, - "com.amazonaws.lexmodelsv2#IntentClosingSetting": { + "com.amazonaws.lexmodelsv2#FilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^[0-9a-zA-Z_()\\s-]+$" + } + }, + "com.amazonaws.lexmodelsv2#FilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#FilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentCodeHookSettings": { "type": "structure", "members": { - "closingResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification", + "enabled": { + "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { - "smithy.api#documentation": "The response that Amazon Lex sends to the user when the intent is\n complete.
" + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether a Lambda function should be invoked to fulfill a\n specific intent.
", + "smithy.api#required": {} } }, - "active": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "postFulfillmentStatusSpecification": { + "target": "com.amazonaws.lexmodelsv2#PostFulfillmentStatusSpecification", "traits": { - "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.
Provides settings for messages sent to the user for after the Lambda\n fulfillment function completes. Post-fulfillment messages can be sent\n for both streaming and non-streaming conversations.
" } }, - "nextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "fulfillmentUpdatesSpecification": { + "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdatesSpecification", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot executes after playing the\n intent's closing response.
" + "smithy.api#documentation": "Provides settings for update messages sent to the user for\n long-running Lambda fulfillment functions. Fulfillment updates can be\n used only with streaming conversations.
" } }, - "conditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "A list of conditional branches associated with the intent's closing\n response. These branches are executed when the nextStep\n attribute is set to EvalutateConditional.
Determines whether the fulfillment code hook is used. When\n active is false, the code hook doesn't run.
Provides a statement the Amazon Lex conveys to the user when the intent\n is successfully fulfilled.
" + "smithy.api#documentation": "Determines if a Lambda function should be invoked for a specific\n intent.
" } }, - "com.amazonaws.lexmodelsv2#IntentConfirmationSetting": { + "com.amazonaws.lexmodelsv2#FulfillmentStartResponseDelay": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 900 + } + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentStartResponseSpecification": { "type": "structure", "members": { - "promptSpecification": { - "target": "com.amazonaws.lexmodelsv2#PromptSpecification", + "delayInSeconds": { + "target": "com.amazonaws.lexmodelsv2#FulfillmentStartResponseDelay", "traits": { - "smithy.api#documentation": "Prompts the user to confirm the intent. This question should have a\n yes or no answer.
\nAmazon Lex uses this prompt to ensure that the user acknowledges that the\n intent is ready for fulfillment. For example, with the\n OrderPizza intent, you might want to confirm that the\n order is correct before placing it. For other intents, such as intents\n that simply respond to user questions, you might not need to ask the\n user for confirmation before providing the information.
The delay between when the Lambda fulfillment function starts running\n and the start message is played. If the Lambda function returns before\n the delay is over, the start message isn't played.
", "smithy.api#required": {} } }, - "declinationResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification", + "messageGroups": { + "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", "traits": { - "smithy.api#documentation": "When the user answers \"no\" to the question defined in\n promptSpecification, Amazon Lex responds with this response\n to acknowledge that the intent was canceled.
1 - 5 message groups that contain start messages. Amazon Lex chooses\n one of the messages to play to the user.
", + "smithy.api#required": {} } }, - "active": { + "allowInterrupt": { "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "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 user can interrupt the start message while it\n is playing.
" } - }, - "confirmationResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "confirmationNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + } + }, + "traits": { + "smithy.api#documentation": "Provides settings for a message that is sent to the user when a\n fulfillment Lambda function starts running.
" + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentTimeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 900 + } + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseFrequency": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 900 + } + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseSpecification": { + "type": "structure", + "members": { + "frequencyInSeconds": { + "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseFrequency", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot executes when the customer\n confirms the intent.
" + "smithy.api#documentation": "The frequency that a message is sent to the user. When the period\n ends, Amazon Lex chooses a message from the message groups and plays it to\n the user. If the fulfillment Lambda returns before the first period\n ends, an update message is not played to the user.
", + "smithy.api#required": {} } }, - "confirmationConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "messageGroups": { + "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the intent is\n closed.
" + "smithy.api#documentation": "1 - 5 message groups that contain update messages. Amazon Lex chooses\n one of the messages to play to the user.
", + "smithy.api#required": {} } }, - "declinationNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot executes when the customer\n declines the intent.
" + "smithy.api#documentation": "Determines whether the user can interrupt an update message while it\n is playing.
" } - }, - "declinationConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + } + }, + "traits": { + "smithy.api#documentation": "Provides settings for a message that is sent periodically to the\n user while a fulfillment Lambda function is running.
" + } + }, + "com.amazonaws.lexmodelsv2#FulfillmentUpdatesSpecification": { + "type": "structure", + "members": { + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the intent is\n declined.
" + "smithy.api#documentation": "Determines whether fulfillment updates are sent to the user. When\n this field is true, updates are sent.
\nIf the active field is set to true, the\n startResponse, updateResponse, and\n timeoutInSeconds fields are required.
The next step to take in the conversation if the confirmation step\n fails.
" + "smithy.api#documentation": "Provides configuration information for the message sent to users\n when the fulfillment Lambda functions starts running.
" } }, - "failureConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" - }, - "codeHook": { - "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", + "updateResponse": { + "target": "com.amazonaws.lexmodelsv2#FulfillmentUpdateResponseSpecification", "traits": { - "smithy.api#documentation": "The DialogCodeHookInvocationSetting object associated\n with intent's confirmation step. The dialog code hook is triggered\n based on these invocation settings when the confirmation next step or\n declination next step or failure next step is\n InvokeDialogCodeHook.
Provides configuration information for messages sent periodically to\n the user while the fulfillment Lambda function is running.
" } }, - "elicitationCodeHook": { - "target": "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting", + "timeoutInSeconds": { + "target": "com.amazonaws.lexmodelsv2#FulfillmentTimeout", "traits": { - "smithy.api#documentation": "The DialogCodeHookInvocationSetting used when the code\n hook is invoked during confirmation prompt retries.
The length of time that the fulfillment Lambda function should run\n before it times out.
" } } }, "traits": { - "smithy.api#documentation": "Provides a prompt for making sure that the user is ready for the\n intent to be fulfilled.
" + "smithy.api#documentation": "Provides information for updating the user on the progress of\n fulfilling an intent.
" } }, - "com.amazonaws.lexmodelsv2#IntentFilter": { + "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrlRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The pre-signed Amazon S3 URL to download the test execution result artifacts.
", + "smithy.api#http": { + "method": "GET", + "uri": "/testexecutions/{testExecutionId}/artifacturl", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrlRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelsv2#IntentFilterName", + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The name of the field to use for the filter.
", + "smithy.api#documentation": "The unique identifier of the completed test execution.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "values": { - "target": "com.amazonaws.lexmodelsv2#FilterValues", + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrlResponse": { + "type": "structure", + "members": { + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The value to use for the filter.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the completed test execution.
" } }, - "operator": { - "target": "com.amazonaws.lexmodelsv2#IntentFilterOperator", + "downloadArtifactsUrl": { + "target": "com.amazonaws.lexmodelsv2#PresignedS3Url", "traits": { - "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListIntents operation should return only aliases that\n equal the specified value. Specify CO when the\n ListIntents operation should return aliases that\n contain the specified value.
The pre-signed Amazon S3 URL to download completed test execution.
" } } }, "traits": { - "smithy.api#documentation": "Filters the response from the ListIntents\n operation.
The source of the grammar used to create the slot type.
" } } + }, + "traits": { + "smithy.api#documentation": "Settings requried for a slot type based on a grammar that you provide.
" } }, - "com.amazonaws.lexmodelsv2#IntentFilterOperator": { - "type": "enum", + "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource": { + "type": "structure", "members": { - "Contains": { - "target": "smithy.api#Unit", + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", "traits": { - "smithy.api#enumValue": "CO" + "smithy.api#documentation": "The name of the Amazon S3 bucket that contains the grammar source.
", + "smithy.api#required": {} } }, - "Equals": { - "target": "smithy.api#Unit", + "s3ObjectKey": { + "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", "traits": { - "smithy.api#enumValue": "EQ" + "smithy.api#documentation": "The path to the grammar in the Amazon S3 bucket.
", + "smithy.api#required": {} } - } - } - }, - "com.amazonaws.lexmodelsv2#IntentFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#IntentFilter" + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The KMS key required to decrypt the contents of the grammar, if any.
" + } + } }, + "traits": { + "smithy.api#documentation": "Describes the Amazon S3 bucket name and location for the grammar\n that is the source for the slot type.
" + } + }, + "com.amazonaws.lexmodelsv2#HitCount": { + "type": "integer" + }, + "com.amazonaws.lexmodelsv2#Id": { + "type": "string", "traits": { "smithy.api#length": { - "min": 1, - "max": 1 - } + "min": 10, + "max": 10 + }, + "smithy.api#pattern": "^[0-9a-zA-Z]+$" } }, - "com.amazonaws.lexmodelsv2#IntentOverride": { + "com.amazonaws.lexmodelsv2#ImageResponseCard": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelsv2#Name", + "title": { + "target": "com.amazonaws.lexmodelsv2#AttachmentTitle", "traits": { - "smithy.api#documentation": "The name of the intent. Only required when you're switching\n intents.
" + "smithy.api#documentation": "The title to display on the response card. The format of the title\n is determined by the platform displaying the response card.
", + "smithy.api#required": {} } }, - "slots": { - "target": "com.amazonaws.lexmodelsv2#SlotValueOverrideMap", + "subtitle": { + "target": "com.amazonaws.lexmodelsv2#AttachmentTitle", + "traits": { + "smithy.api#documentation": "The subtitle to display on the response card. The format of the\n subtitle is determined by the platform displaying the response\n card.
" + } + }, + "imageUrl": { + "target": "com.amazonaws.lexmodelsv2#AttachmentUrl", + "traits": { + "smithy.api#documentation": "The URL of an image to display on the response card. The image URL\n must be publicly available so that the platform displaying the response\n card has access to the image.
" + } + }, + "buttons": { + "target": "com.amazonaws.lexmodelsv2#ButtonsList", "traits": { - "smithy.api#documentation": "A map of all of the slot value overrides for the intent. The name of\n the slot maps to the value of the slot. Slots that are not included in\n the map aren't overridden.,
" + "smithy.api#documentation": "A list of buttons that should be displayed on the response card. The\n arrangement of the buttons is determined by the platform that displays\n the button.
" } } }, "traits": { - "smithy.api#documentation": "Override settings to configure the intent state.
" + "smithy.api#documentation": "A card that is shown to the user by a messaging platform. You define\n the contents of the card, the card is displayed by the platform.
\nWhen you use a response card, the response from the user is\n constrained to the text associated with a button on the card.
" } }, - "com.amazonaws.lexmodelsv2#IntentSignature": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#IntentSortAttribute": { + "com.amazonaws.lexmodelsv2#ImportExportFileFormat": { "type": "enum", "members": { - "IntentName": { + "LexJson": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "IntentName" + "smithy.api#enumValue": "LexJson" } }, - "LastUpdatedDateTime": { + "TSV": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LastUpdatedDateTime" + "smithy.api#enumValue": "TSV" + } + }, + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" } } } }, - "com.amazonaws.lexmodelsv2#IntentSortBy": { + "com.amazonaws.lexmodelsv2#ImportExportFilePassword": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.lexmodelsv2#ImportFilter": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.lexmodelsv2#IntentSortAttribute", + "name": { + "target": "com.amazonaws.lexmodelsv2#ImportFilterName", "traits": { - "smithy.api#documentation": "The attribute to use to sort the list of intents.
", + "smithy.api#documentation": "The name of the field to use for filtering.
", "smithy.api#required": {} } }, - "order": { - "target": "com.amazonaws.lexmodelsv2#SortOrder", + "values": { + "target": "com.amazonaws.lexmodelsv2#FilterValues", "traits": { - "smithy.api#documentation": "The order to sort the list. You can choose ascending or\n descending.
", + "smithy.api#documentation": "The values to use to filter the response. The values must be\n Bot, BotLocale, or\n CustomVocabulary.
The operator to use for the filter. Specify EQ when the\n ListImports operation should return only resource types\n that equal the specified value. Specify CO when the\n ListImports operation should return resource types that\n contain the specified value.
Specifies attributes for sorting a list of intents.
" + "smithy.api#documentation": "Filters the response from the ListImports operation.
" } }, - "com.amazonaws.lexmodelsv2#IntentStatistics": { - "type": "structure", + "com.amazonaws.lexmodelsv2#ImportFilterName": { + "type": "enum", "members": { - "discoveredIntentCount": { - "target": "com.amazonaws.lexmodelsv2#Count", + "ImportResourceType": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImportResourceType" + } + } + } + }, + "com.amazonaws.lexmodelsv2#ImportFilterOperator": { + "type": "enum", + "members": { + "Contains": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The number of recommended intents associated with the bot\n recommendation.
" + "smithy.api#enumValue": "CO" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } } + } + }, + "com.amazonaws.lexmodelsv2#ImportFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ImportFilter" }, "traits": { - "smithy.api#documentation": "The object that contains the statistical summary of recommended\n intents associated with the bot recommendation.
" + "smithy.api#length": { + "min": 1, + "max": 1 + } } }, - "com.amazonaws.lexmodelsv2#IntentSummary": { + "com.amazonaws.lexmodelsv2#ImportResourceSpecification": { "type": "structure", "members": { - "intentId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "botImportSpecification": { + "target": "com.amazonaws.lexmodelsv2#BotImportSpecification", "traits": { - "smithy.api#documentation": "The unique identifier assigned to the intent. Use this ID to get\n detailed information about the intent with the\n DescribeIntent operation.
Parameters for importing a bot.
" } }, - "intentName": { - "target": "com.amazonaws.lexmodelsv2#Name", + "botLocaleImportSpecification": { + "target": "com.amazonaws.lexmodelsv2#BotLocaleImportSpecification", "traits": { - "smithy.api#documentation": "The name of the intent.
" + "smithy.api#documentation": "Parameters for importing a bot locale.
" } }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", + "customVocabularyImportSpecification": { + "target": "com.amazonaws.lexmodelsv2#CustomVocabularyImportSpecification" + }, + "testSetImportResourceSpecification": { + "target": "com.amazonaws.lexmodelsv2#TestSetImportResourceSpecification", "traits": { - "smithy.api#documentation": "The description of the intent.
" + "smithy.api#documentation": "Specifications for the test set that is imported.
" } - }, - "parentIntentSignature": { - "target": "com.amazonaws.lexmodelsv2#IntentSignature", + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the bot or bot locale that you want to\n import. You can specify the botImportSpecification or the\n botLocaleImportSpecification, but not both.
If this intent is derived from a built-in intent, the name of the\n parent intent.
" + "smithy.api#enumValue": "Bot" } }, - "inputContexts": { - "target": "com.amazonaws.lexmodelsv2#InputContextsList", + "BotLocale": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The input contexts that must be active for this intent to be\n considered for recognition.
" + "smithy.api#enumValue": "BotLocale" } }, - "outputContexts": { - "target": "com.amazonaws.lexmodelsv2#OutputContextsList", + "CustomVocabulary": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The output contexts that are activated when this intent is\n fulfilled.
" + "smithy.api#enumValue": "CustomVocabulary" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", + "TestSet": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The timestamp of the date and time that the intent was last\n updated.
" + "smithy.api#enumValue": "TestSet" } } - }, - "traits": { - "smithy.api#documentation": "Summary information about an intent returned by the\n ListIntents operation.
The service encountered an unexpected condition. Try your request\n again.
", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.lexmodelsv2#ItemId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" + } } } }, - "com.amazonaws.lexmodelsv2#KendraConfiguration": { + "com.amazonaws.lexmodelsv2#ImportSortBy": { "type": "structure", "members": { - "kendraIndex": { - "target": "com.amazonaws.lexmodelsv2#KendraIndexArn", + "attribute": { + "target": "com.amazonaws.lexmodelsv2#ImportSortAttribute", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the\n AMAZON.KendraSearchIntent intent to search. The index must be in the\n same account and Region as the Amazon Lex bot.
", + "smithy.api#documentation": "The export field to use for sorting.
", "smithy.api#required": {} } }, - "queryFilterStringEnabled": { - "target": "com.amazonaws.lexmodelsv2#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Determines whether the AMAZON.KendraSearchIntent intent uses a\n custom query string to query the Amazon Kendra index.
" - } - }, - "queryFilterString": { - "target": "com.amazonaws.lexmodelsv2#QueryFilterString", + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", "traits": { - "smithy.api#documentation": "A query filter that Amazon Lex sends to Amazon Kendra to filter the response from\n a query. The filter is in the format defined by Amazon Kendra. For more\n information, see Filtering\n queries.
" + "smithy.api#documentation": "The order to sort the list.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides configuration information for the AMAZON.KendraSearchIntent\n intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra\n index and returns documents from the index that match the user's\n utterance.
" + "smithy.api#documentation": "Provides information for sorting a list of imports.
" } }, - "com.amazonaws.lexmodelsv2#KendraIndexArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 2048 + "com.amazonaws.lexmodelsv2#ImportStatus": { + "type": "enum", + "members": { + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } }, - "smithy.api#pattern": "^arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\\/[a-zA-Z0-9][a-zA-Z0-9_-]*$" + "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#KmsKeyArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 + "com.amazonaws.lexmodelsv2#ImportSummary": { + "type": "structure", + "members": { + "importId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the import.
" + } }, - "smithy.api#pattern": "^arn:[\\w\\-]+:kms:[\\w\\-]+:[\\d]{12}:(?:key\\/[\\w\\-]+|alias\\/[a-zA-Z0-9:\\/_\\-]{1,256})$" + "importedResourceId": { + "target": "com.amazonaws.lexmodelsv2#ImportedResourceId", + "traits": { + "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the imported\n resource.
" + } + }, + "importedResourceName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name that you gave the imported resource.
" + } + }, + "importStatus": { + "target": "com.amazonaws.lexmodelsv2#ImportStatus", + "traits": { + "smithy.api#documentation": "The status of the resource. When the status is\n Completed the resource is ready to build.
The strategy used to merge existing bot or bot locale definitions\n with the imported definition.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the import was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the import was last updated.
" + } + }, + "importedResourceType": { + "target": "com.amazonaws.lexmodelsv2#ImportResourceType", + "traits": { + "smithy.api#documentation": "The type of resource that was imported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides summary information about an import in an import\n list.
" } }, - "com.amazonaws.lexmodelsv2#LambdaARN": { + "com.amazonaws.lexmodelsv2#ImportSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ImportSummary" + } + }, + "com.amazonaws.lexmodelsv2#ImportedResourceId": { "type": "string", "traits": { "smithy.api#length": { - "min": 20, - "max": 2048 + "min": 5, + "max": 10 }, - "smithy.api#pattern": "^arn:aws:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?$" + "smithy.api#pattern": "^([0-9a-zA-Z_])+$" } }, - "com.amazonaws.lexmodelsv2#LambdaCodeHook": { + "com.amazonaws.lexmodelsv2#InitialResponseSetting": { "type": "structure", "members": { - "lambdaARN": { - "target": "com.amazonaws.lexmodelsv2#LambdaARN", + "initialResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "nextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Lambda function.
", - "smithy.api#required": {} + "smithy.api#documentation": "The next step in the conversation.
" } }, - "codeHookInterfaceVersion": { - "target": "com.amazonaws.lexmodelsv2#CodeHookInterfaceVersion", + "conditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" + }, + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting" + } + }, + "traits": { + "smithy.api#documentation": "Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
" + } + }, + "com.amazonaws.lexmodelsv2#InputContext": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The version of the request-response that you want Amazon Lex to use to\n invoke your Lambda function.
", + "smithy.api#documentation": "The name of the context.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies a Lambda function that verifies requests to a bot or\n fulfills the user's request to a bot.
" + "smithy.api#documentation": "A context that must be active for an intent to be\n selected by Amazon Lex.
" } }, - "com.amazonaws.lexmodelsv2#LexModelBuildingServiceV2": { - "type": "service", - "version": "2020-08-07", - "operations": [ - { - "target": "com.amazonaws.lexmodelsv2#BatchCreateCustomVocabularyItem" - }, - { - "target": "com.amazonaws.lexmodelsv2#BatchDeleteCustomVocabularyItem" - }, - { - "target": "com.amazonaws.lexmodelsv2#BatchUpdateCustomVocabularyItem" - }, - { - "target": "com.amazonaws.lexmodelsv2#BuildBotLocale" - }, - { - "target": "com.amazonaws.lexmodelsv2#CreateBot" + "com.amazonaws.lexmodelsv2#InputContextsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#InputContext" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.lexmodelsv2#InputSessionStateSpecification": { + "type": "structure", + "members": { + "sessionAttributes": { + "target": "com.amazonaws.lexmodelsv2#StringMap", + "traits": { + "smithy.api#documentation": "Session attributes for the session state.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateBotAlias" + "activeContexts": { + "target": "com.amazonaws.lexmodelsv2#ActiveContextList", + "traits": { + "smithy.api#documentation": "Active contexts for the session state.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateBotLocale" + "runtimeHints": { + "target": "com.amazonaws.lexmodelsv2#RuntimeHints", + "traits": { + "smithy.api#documentation": "Runtime hints for the session state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifications for the current state of the dialog \n between the user and the bot in the test set.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItem": { + "type": "structure", + "members": { + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name of the intent.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateBotVersion" + "multiTurnConversation": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the conversation involves multiple turns or not.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateExport" + "resultCounts": { + "target": "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItemCounts", + "traits": { + "smithy.api#documentation": "The result of the intent classification test.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information for an intent that is classified by the test workbench.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItemCounts": { + "type": "structure", + "members": { + "totalResultCount": { + "target": "com.amazonaws.lexmodelsv2#Count", + "traits": { + "smithy.api#documentation": "The total number of results in the intent classification test.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateIntent" + "speechTranscriptionResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", + "traits": { + "smithy.api#documentation": "The number of matched, mismatched, and execution error results for speech transcription for the intent.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateResourcePolicy" + "intentMatchResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", + "traits": { + "smithy.api#documentation": "The number of matched and mismatched results for intent recognition for the intent.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The number of items in the intent classification test.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItem" + } + }, + "com.amazonaws.lexmodelsv2#IntentClassificationTestResults": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.lexmodelsv2#IntentClassificationTestResultItemList", + "traits": { + "smithy.api#documentation": "A list of the results for the intent classification test.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information for the results of the intent classification test.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentClosingSetting": { + "type": "structure", + "members": { + "closingResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification", + "traits": { + "smithy.api#documentation": "The response that Amazon Lex sends to the user when the intent is\n complete.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateResourcePolicyStatement" + "active": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "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 the next step that the bot executes after playing the\n intent's closing response.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#CreateSlotType" - }, - { - "target": "com.amazonaws.lexmodelsv2#CreateUploadUrl" - }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteBot" - }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteBotAlias" - }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteBotLocale" - }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteBotVersion" + "conditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "A list of conditional branches associated with the intent's closing\n response. These branches are executed when the nextStep\n attribute is set to EvalutateConditional.
Provides a statement the Amazon Lex conveys to the user when the intent\n is successfully fulfilled.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentConfirmationSetting": { + "type": "structure", + "members": { + "promptSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptSpecification", + "traits": { + "smithy.api#documentation": "Prompts the user to confirm the intent. This question should have a\n yes or no answer.
\nAmazon Lex uses this prompt to ensure that the user acknowledges that the\n intent is ready for fulfillment. For example, with the\n OrderPizza intent, you might want to confirm that the\n order is correct before placing it. For other intents, such as intents\n that simply respond to user questions, you might not need to ask the\n user for confirmation before providing the information.
When the user answers \"no\" to the question defined in\n promptSpecification, Amazon Lex responds with this response\n to acknowledge that the intent was canceled.
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.
Specifies the next step that the bot executes when the customer\n confirms the intent.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteResourcePolicy" + "confirmationConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "A list of conditional branches to evaluate after the intent is\n closed.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteResourcePolicyStatement" + "declinationNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "Specifies the next step that the bot executes when the customer\n declines the intent.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteSlot" + "declinationConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "A list of conditional branches to evaluate after the intent is\n declined.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteSlotType" + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" }, - { - "target": "com.amazonaws.lexmodelsv2#DeleteUtterances" + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", + "traits": { + "smithy.api#documentation": "The next step to take in the conversation if the confirmation step\n fails.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeBot" + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification" }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeBotAlias" + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", + "traits": { + "smithy.api#documentation": "The DialogCodeHookInvocationSetting object associated\n with intent's confirmation step. The dialog code hook is triggered\n based on these invocation settings when the confirmation next step or\n declination next step or failure next step is\n InvokeDialogCodeHook.
The DialogCodeHookInvocationSetting used when the code\n hook is invoked during confirmation prompt retries.
Provides a prompt for making sure that the user is ready for the\n intent to be fulfilled.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#IntentFilterName", + "traits": { + "smithy.api#documentation": "The name of the field to use for the filter.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendation" + "values": { + "target": "com.amazonaws.lexmodelsv2#FilterValues", + "traits": { + "smithy.api#documentation": "The value to use for the filter.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeBotVersion" + "operator": { + "target": "com.amazonaws.lexmodelsv2#IntentFilterOperator", + "traits": { + "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListIntents operation should return only aliases that\n equal the specified value. Specify CO when the\n ListIntents operation should return aliases that\n contain the specified value.
Filters the response from the ListIntents\n operation.
The name of the intent that was recognized.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeExport" + "multiTurnConversation": { + "target": "com.amazonaws.lexmodelsv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the conversation involves multiple turns or not.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeImport" + "slotResolutionResults": { + "target": "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItems", + "traits": { + "smithy.api#documentation": "The results for the slot resolution in the test execution result.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about intent-level slot resolution in a test result.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentLevelSlotResolutionTestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#IntentLevelSlotResolutionTestResultItem" + } + }, + "com.amazonaws.lexmodelsv2#IntentLevelSlotResolutionTestResults": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.lexmodelsv2#IntentLevelSlotResolutionTestResultItemList", + "traits": { + "smithy.api#documentation": "Indicates the items for the slot level resolution for the intents.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the success or failure of slots at the intent level.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentOverride": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name of the intent. Only required when you're switching\n intents.
" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeIntent" + "slots": { + "target": "com.amazonaws.lexmodelsv2#SlotValueOverrideMap", + "traits": { + "smithy.api#documentation": "A map of all of the slot value overrides for the intent. The name of\n the slot maps to the value of the slot. Slots that are not included in\n the map aren't overridden.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Override settings to configure the intent state.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentSignature": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#IntentSortAttribute": { + "type": "enum", + "members": { + "IntentName": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IntentName" + } }, - { - "target": "com.amazonaws.lexmodelsv2#DescribeResourcePolicy" + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastUpdatedDateTime" + } + } + } + }, + "com.amazonaws.lexmodelsv2#IntentSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.lexmodelsv2#IntentSortAttribute", + "traits": { + "smithy.api#documentation": "The attribute to use to sort the list of intents.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort the list. You can choose ascending or\n descending.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies attributes for sorting a list of intents.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentStatistics": { + "type": "structure", + "members": { + "discoveredIntentCount": { + "target": "com.amazonaws.lexmodelsv2#Count", + "traits": { + "smithy.api#documentation": "The number of recommended intents associated with the bot\n recommendation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that contains the statistical summary of recommended\n intents associated with the bot recommendation.
" + } + }, + "com.amazonaws.lexmodelsv2#IntentSummary": { + "type": "structure", + "members": { + "intentId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier assigned to the intent. Use this ID to get\n detailed information about the intent with the\n DescribeIntent operation.
The name of the intent.
" + } + }, + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", + "traits": { + "smithy.api#documentation": "The description of the intent.
" + } + }, + "parentIntentSignature": { + "target": "com.amazonaws.lexmodelsv2#IntentSignature", + "traits": { + "smithy.api#documentation": "If this intent is derived from a built-in intent, the name of the\n parent intent.
" + } + }, + "inputContexts": { + "target": "com.amazonaws.lexmodelsv2#InputContextsList", + "traits": { + "smithy.api#documentation": "The input contexts that must be active for this intent to be\n considered for recognition.
" + } + }, + "outputContexts": { + "target": "com.amazonaws.lexmodelsv2#OutputContextsList", + "traits": { + "smithy.api#documentation": "The output contexts that are activated when this intent is\n fulfilled.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the date and time that the intent was last\n updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about an intent returned by the\n ListIntents operation.
The service encountered an unexpected condition. Try your request\n again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.lexmodelsv2#ItemId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.lexmodelsv2#KendraConfiguration": { + "type": "structure", + "members": { + "kendraIndex": { + "target": "com.amazonaws.lexmodelsv2#KendraIndexArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the\n AMAZON.KendraSearchIntent intent to search. The index must be in the\n same account and Region as the Amazon Lex bot.
Determines whether the AMAZON.KendraSearchIntent intent uses a\n custom query string to query the Amazon Kendra index.
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from\n a query. The filter is in the format defined by Amazon Kendra. For more\n information, see Filtering\n queries.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides configuration information for the AMAZON.KendraSearchIntent\n intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra\n index and returns documents from the index that match the user's\n utterance.
The Amazon Resource Name (ARN) of the Lambda function.
", + "smithy.api#required": {} + } + }, + "codeHookInterfaceVersion": { + "target": "com.amazonaws.lexmodelsv2#CodeHookInterfaceVersion", + "traits": { + "smithy.api#documentation": "The version of the request-response that you want Amazon Lex to use to\n invoke your Lambda function.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Lambda function that verifies requests to a bot or\n fulfills the user's request to a bot.
" + } + }, + "com.amazonaws.lexmodelsv2#LexModelBuildingServiceV2": { + "type": "service", + "version": "2020-08-07", + "operations": [ { - "target": "com.amazonaws.lexmodelsv2#DescribeSlot" + "target": "com.amazonaws.lexmodelsv2#BatchCreateCustomVocabularyItem" }, { - "target": "com.amazonaws.lexmodelsv2#DescribeSlotType" + "target": "com.amazonaws.lexmodelsv2#BatchDeleteCustomVocabularyItem" }, { - "target": "com.amazonaws.lexmodelsv2#ListAggregatedUtterances" + "target": "com.amazonaws.lexmodelsv2#BatchUpdateCustomVocabularyItem" }, { - "target": "com.amazonaws.lexmodelsv2#ListBotAliases" + "target": "com.amazonaws.lexmodelsv2#BuildBotLocale" }, { - "target": "com.amazonaws.lexmodelsv2#ListBotLocales" + "target": "com.amazonaws.lexmodelsv2#CreateBot" }, { - "target": "com.amazonaws.lexmodelsv2#ListBotRecommendations" + "target": "com.amazonaws.lexmodelsv2#CreateBotAlias" }, { - "target": "com.amazonaws.lexmodelsv2#ListBots" + "target": "com.amazonaws.lexmodelsv2#CreateBotLocale" }, { - "target": "com.amazonaws.lexmodelsv2#ListBotVersions" + "target": "com.amazonaws.lexmodelsv2#CreateBotVersion" }, { - "target": "com.amazonaws.lexmodelsv2#ListBuiltInIntents" + "target": "com.amazonaws.lexmodelsv2#CreateExport" }, { - "target": "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypes" + "target": "com.amazonaws.lexmodelsv2#CreateIntent" }, { - "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItems" + "target": "com.amazonaws.lexmodelsv2#CreateResourcePolicy" }, { - "target": "com.amazonaws.lexmodelsv2#ListExports" + "target": "com.amazonaws.lexmodelsv2#CreateResourcePolicyStatement" }, { - "target": "com.amazonaws.lexmodelsv2#ListImports" + "target": "com.amazonaws.lexmodelsv2#CreateSlot" }, { - "target": "com.amazonaws.lexmodelsv2#ListIntents" + "target": "com.amazonaws.lexmodelsv2#CreateSlotType" }, { - "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntents" + "target": "com.amazonaws.lexmodelsv2#CreateTestSetDiscrepancyReport" }, { - "target": "com.amazonaws.lexmodelsv2#ListSlots" + "target": "com.amazonaws.lexmodelsv2#CreateUploadUrl" }, { - "target": "com.amazonaws.lexmodelsv2#ListSlotTypes" + "target": "com.amazonaws.lexmodelsv2#DeleteBot" }, { - "target": "com.amazonaws.lexmodelsv2#ListTagsForResource" + "target": "com.amazonaws.lexmodelsv2#DeleteBotAlias" }, { - "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts" + "target": "com.amazonaws.lexmodelsv2#DeleteBotLocale" }, { - "target": "com.amazonaws.lexmodelsv2#StartBotRecommendation" + "target": "com.amazonaws.lexmodelsv2#DeleteBotVersion" }, { - "target": "com.amazonaws.lexmodelsv2#StartImport" + "target": "com.amazonaws.lexmodelsv2#DeleteCustomVocabulary" }, { - "target": "com.amazonaws.lexmodelsv2#StopBotRecommendation" + "target": "com.amazonaws.lexmodelsv2#DeleteExport" }, { - "target": "com.amazonaws.lexmodelsv2#TagResource" + "target": "com.amazonaws.lexmodelsv2#DeleteImport" }, { - "target": "com.amazonaws.lexmodelsv2#UntagResource" + "target": "com.amazonaws.lexmodelsv2#DeleteIntent" }, { - "target": "com.amazonaws.lexmodelsv2#UpdateBot" + "target": "com.amazonaws.lexmodelsv2#DeleteResourcePolicy" }, { - "target": "com.amazonaws.lexmodelsv2#UpdateBotAlias" + "target": "com.amazonaws.lexmodelsv2#DeleteResourcePolicyStatement" }, { - "target": "com.amazonaws.lexmodelsv2#UpdateBotLocale" + "target": "com.amazonaws.lexmodelsv2#DeleteSlot" }, { - "target": "com.amazonaws.lexmodelsv2#UpdateBotRecommendation" + "target": "com.amazonaws.lexmodelsv2#DeleteSlotType" }, { - "target": "com.amazonaws.lexmodelsv2#UpdateExport" + "target": "com.amazonaws.lexmodelsv2#DeleteTestSet" + }, + { + "target": "com.amazonaws.lexmodelsv2#DeleteUtterances" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBot" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotAlias" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotLocale" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotRecommendation" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeBotVersion" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeCustomVocabularyMetadata" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeExport" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeImport" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeIntent" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeResourcePolicy" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeSlot" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeSlotType" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeTestExecution" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSet" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetDiscrepancyReport" + }, + { + "target": "com.amazonaws.lexmodelsv2#DescribeTestSetGeneration" + }, + { + "target": "com.amazonaws.lexmodelsv2#GetTestExecutionArtifactsUrl" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListAggregatedUtterances" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotAliases" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotLocales" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotRecommendations" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBots" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBotVersions" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBuiltInIntents" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypes" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItems" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListExports" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListImports" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListIntents" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntents" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListSlots" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListSlotTypes" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListTagsForResource" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListTestExecutionResultItems" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListTestExecutions" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListTestSetRecords" + }, + { + "target": "com.amazonaws.lexmodelsv2#ListTestSets" + }, + { + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts" + }, + { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendation" + }, + { + "target": "com.amazonaws.lexmodelsv2#StartImport" + }, + { + "target": "com.amazonaws.lexmodelsv2#StartTestExecution" + }, + { + "target": "com.amazonaws.lexmodelsv2#StartTestSetGeneration" + }, + { + "target": "com.amazonaws.lexmodelsv2#StopBotRecommendation" + }, + { + "target": "com.amazonaws.lexmodelsv2#TagResource" + }, + { + "target": "com.amazonaws.lexmodelsv2#UntagResource" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateBot" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateBotAlias" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateBotLocale" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateBotRecommendation" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateExport" }, { "target": "com.amazonaws.lexmodelsv2#UpdateIntent" @@ -9003,6 +10533,9 @@ }, { "target": "com.amazonaws.lexmodelsv2#UpdateSlotType" + }, + { + "target": "com.amazonaws.lexmodelsv2#UpdateTestSet" } ], "traits": { @@ -9815,34 +11348,1806 @@ } } }, - "com.amazonaws.lexmodelsv2#LexTranscriptFilter": { + "com.amazonaws.lexmodelsv2#LexTranscriptFilter": { + "type": "structure", + "members": { + "dateRangeFilter": { + "target": "com.amazonaws.lexmodelsv2#DateRangeFilter", + "traits": { + "smithy.api#documentation": "The object that contains a date range filter that will be applied to\n the transcript. Specify this object if you want Amazon Lex to only read the\n files that are within the date range.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that contains transcript filter details that are\n associated with a bot recommendation.
" + } + }, + "com.amazonaws.lexmodelsv2#ListAggregatedUtterances": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListAggregatedUtterancesRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListAggregatedUtterancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a list of utterances that users have sent to the\n bot.
\nUtterances are aggregated by the text of the utterance. For example,\n all instances where customers used the phrase \"I want to order pizza\"\n are aggregated into the same line in the response.
\nYou can see both detected utterances and missed utterances. A\n detected utterance is where the bot properly recognized the utterance\n and activated the associated intent. A missed utterance was not\n recognized by the bot and didn't activate an intent.
\nUtterances can be aggregated for a bot alias or for a bot version,\n but not both at the same time.
\nUtterances statistics are not generated under the following\n conditions:
\nThe childDirected field was set to true when the\n bot was created.
You are using slot obfuscation with one or more slots.
\nYou opted out of participating in improving Amazon Lex.
\nThe unique identifier of the bot associated with this\n request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "traits": { + "smithy.api#documentation": "The identifier of the bot alias associated with this request. If you\n specify the bot alias, you can't specify the bot version.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The identifier of the bot version associated with this request. If\n you specify the bot version, you can't specify the bot alias.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale where the utterances were\n collected. For more information, see Supported\n languages.
", + "smithy.api#required": {} + } + }, + "aggregationDuration": { + "target": "com.amazonaws.lexmodelsv2#UtteranceAggregationDuration", + "traits": { + "smithy.api#documentation": "The time window for aggregating the utterance information. You can\n specify a time between one hour and two weeks.
", + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#AggregatedUtterancesSortBy", + "traits": { + "smithy.api#documentation": "Specifies sorting parameters for the list of utterances. You can\n sort by the hit count, the missed count, or the number of distinct\n sessions the utterance appeared in.
" + } + }, + "filters": { + "target": "com.amazonaws.lexmodelsv2#AggregatedUtterancesFilters", + "traits": { + "smithy.api#documentation": "Provides the specification of a filter used to limit the utterances\n in the response to only those that match the filter specification. You\n can only specify one filter and one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of utterances to return in each page of results.\n If there are fewer results than the maximum page size, only the actual\n number of results are returned. If you don't specify the\n maxResults parameter, 1,000 results are\n returned.
If the response from the ListAggregatedUtterances\n operation contains more results that specified in the\n maxResults parameter, a token is returned in the\n response. Use that token in the nextToken parameter to\n return the next page of results.
The identifier of the bot that contains the utterances.
" + } + }, + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "traits": { + "smithy.api#documentation": "The identifier of the bot alias that contains the utterances. If you\n specified the bot version, the bot alias ID isn't returned.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The identifier of the bot version that contains the utterances. If\n you specified the bot alias, the bot version isn't returned.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale that the utterances are\n in.
" + } + }, + "aggregationDuration": { + "target": "com.amazonaws.lexmodelsv2#UtteranceAggregationDuration", + "traits": { + "smithy.api#documentation": "The time period used to aggregate the utterance data.
" + } + }, + "aggregationWindowStartTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the aggregation window begins. Only data\n collected after this time is returned in the results.
" + } + }, + "aggregationWindowEndTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the aggregation window ends. Only data\n collected between the start time and the end time are returned in the\n results.
" + } + }, + "aggregationLastRefreshedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The last date and time that the aggregated data was collected. The\n time period depends on the length of the aggregation window.
\n\n Hours - for 1 hour time\n window, every half hour; otherwise every hour.
\n\n Days - every 6 hours
\n\n Weeks - for a one week time\n window, every 12 hours; otherwise, every day
\nSummaries of the aggregated utterance data. Each response contains\n information about the number of times that the utterance was seen\n during the time period, whether it was detected or missed, and when it\n was seen during the time period.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListAggregatedUtterances operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a\n ListAggregatedUtterances operation request to get the\n next page of results.
Gets a list of aliases for the specified bot.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botaliases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotAliasesRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot to list aliases for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of aliases to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBotAliases operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
Summary information for the bot aliases that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more aliases available, the nextToken field contains a\n token to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListBotAliases operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
The identifier of the bot associated with the aliases.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotLocales": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotLocalesRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotLocalesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of locales for the specified bot.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotLocalesRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot to list locales for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot to list locales for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BotLocaleSortBy", + "traits": { + "smithy.api#documentation": "Specifies sorting parameters for the list of locales. You can sort\n by locale name in ascending or descending order.
" + } + }, + "filters": { + "target": "com.amazonaws.lexmodelsv2#BotLocaleFilters", + "traits": { + "smithy.api#documentation": "Provides the specification for a filter used to limit the response\n to only those locales that match the filter specification. You can only\n specify one filter and one value to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of aliases to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBotLocales operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token as the\n nextToken parameter to return the next page of results.\n
The identifier of the bot to list locales for.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotLocales operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotLocales\n operation request to get the next page of results.
Summary information for the locales that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n locales available, the nextToken field contains a token to\n get the next page of results.
Get a list of bot recommendations that meet the specified\n criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotRecommendationsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBotRecommendation operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotRecommendationsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
" + } + }, + "botRecommendationSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the bot recommendations that meet the filter\n specified in this request. The length of the list is specified in the\n maxResults parameter of the request. If there are more bot\n recommendations available, the nextToken field contains a token to get\n the next page of results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotRecommendations operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListBotRecommendations operation request to get the next page of\n results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBotVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBotVersionsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBotVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information about all of the versions of a bot.
\nThe ListBotVersions operation returns a summary of each\n version of a bot. For example, if a bot has three numbered versions,\n the ListBotVersions operation returns for summaries, one\n for each numbered version and one for the DRAFT\n version.
The ListBotVersions operation always returns at least\n one version, the DRAFT version.
The identifier of the bot to list versions for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BotVersionSortBy", + "traits": { + "smithy.api#documentation": "Specifies sorting parameters for the list of versions. You can\n specify that the list be sorted by version name in either ascending or\n descending order.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of versions to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response to the ListBotVersion operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
The identifier of the bot to list versions for.
" + } + }, + "botVersionSummaries": { + "target": "com.amazonaws.lexmodelsv2#BotVersionSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the bot versions that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more versions available, the nextToken field contains a\n token to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListBotVersions operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
Gets a list of available bots.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBotsRequest": { + "type": "structure", + "members": { + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BotSortBy", + "traits": { + "smithy.api#documentation": "Specifies sorting parameters for the list of bots. You can specify\n that the list be sorted by bot name in ascending or descending\n order.
" + } + }, + "filters": { + "target": "com.amazonaws.lexmodelsv2#BotFilters", + "traits": { + "smithy.api#documentation": "Provides the specification of a filter used to limit the bots in the\n response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bots to return in each page of results. If\n there are fewer results than the maximum page size, only the actual\n number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBots operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListBots request to return the next page of results.\n For a complete set of results, call the ListBots operation\n until the nextToken returned in the response is\n null.
Summary information for the bots that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n bots available, the nextToken field contains a token to\n the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListBots operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBots\n operation request to get the next page of results.
Gets a list of built-in intents provided by Amazon Lex that you can use\n in your bot.
\nTo use a built-in intent as a the base for your own intent, include\n the built-in intent signature in the parentIntentSignature\n parameter when you call the CreateIntent operation. For\n more information, see CreateIntent.
The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BuiltInIntentSortBy", + "traits": { + "smithy.api#documentation": "Specifies sorting parameters for the list of built-in intents. You\n can specify that the list be sorted by the built-in intent signature in\n either ascending or descending order.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#BuiltInsMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of built-in intents to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBuiltInIntents operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
Summary information for the built-in intents that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more intents available, the nextToken field contains a\n token to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListBuiltInIntents operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
The language and locale of the intents in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypesRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of built-in slot types that meet the specified\n criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/builtins/locales/{localeId}/slottypes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypesRequest": { + "type": "structure", + "members": { + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#BuiltInSlotTypeSortBy", + "traits": { + "smithy.api#documentation": "Determines the sort order for the response from the\n ListBuiltInSlotTypes operation. You can choose to sort\n by the slot type signature in either ascending or descending\n order.
The maximum number of built-in slot types to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListBuiltInSlotTypes operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
Summary information for the built-in slot types that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more slot types available, the nextToken field contains a\n token to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListBuiltInSlotTypes operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a\n LIstBuiltInSlotTypes operation request to get the next\n page of results.
The language and locale of the slot types in the list.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListCustomVocabularyItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Paginated list of custom vocabulary items for a given bot locale's \n custom vocabulary.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/list", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the version of the bot associated with this custom \n vocabulary.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The bot version of the bot to the list custom vocabulary \n request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale where this custom vocabulary \n is used. The string must match one of the supported locales. For more \n information, see Supported \n languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of items returned by the list operation.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "The nextToken identifier to the list custom vocabulary \n request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot associated with this custom vocabulary.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The identifier of the version of the bot associated with this custom \n vocabulary.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale where this custom vocabulary \n is used. The string must match one of the supported locales. For more \n information, see Supported Languages .
" + } + }, + "customVocabularyItems": { + "target": "com.amazonaws.lexmodelsv2#CustomVocabularyItems", + "traits": { + "smithy.api#documentation": "The custom vocabulary items from the list custom vocabulary \n response.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "The nextToken identifier to the list custom vocabulary \n response.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListExportsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListExportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the exports for a bot, bot locale, or custom vocabulary.\n Exports are kept in the list for 7 days.
", + "smithy.api#http": { + "method": "POST", + "uri": "/exports", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListExportsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the bot.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot to list exports for.
" + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#ExportSortBy", + "traits": { + "smithy.api#documentation": "Determines the field that the list of exports is sorted by. You can\n sort by the LastUpdatedDateTime field in ascending or\n descending order.
Provides the specification of a filter used to limit the exports in\n the response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of exports to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListExports operation contains\n more results that specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListExports request to return the next page of results.\n For a complete set of results, call the ListExports\n operation until the nextToken returned in the response is\n null.
Specifies the resources that should be exported. If you\n don't specify a resource type in the filters parameter,\n both bot locales and custom vocabularies are exported.
The unique identifier assigned to the bot by Amazon Lex.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that was exported.
" + } + }, + "exportSummaries": { + "target": "com.amazonaws.lexmodelsv2#ExportSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the exports that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter. If there are more exports\n available, the nextToken field contains a token to get the\n next page of results.
A token that indicates whether there are more results to return in a\n response to the ListExports operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListExports\n operation request to get the next page of results.
The locale specified in the request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListImports": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListImportsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListImportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the imports for a bot, bot locale, or custom vocabulary.\n Imports are kept in the list for 7 days.
", + "smithy.api#http": { + "method": "POST", + "uri": "/imports", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListImportsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the bot.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot to list imports for.
" + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#ImportSortBy", + "traits": { + "smithy.api#documentation": "Determines the field that the list of imports is sorted by. You can\n sort by the LastUpdatedDateTime field in ascending or\n descending order.
Provides the specification of a filter used to limit the bots in the\n response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of imports to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListImports operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListImports request to return the next page of results.\n For a complete set of results, call the ListImports\n operation until the nextToken returned in the response is\n null.
Specifies the locale that should be present in the list. If you\n don't specify a resource type in the filters parameter,\n the list contains both bot locales and custom vocabularies.
The unique identifier assigned by Amazon Lex to the bot.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that was imported. It will always be\n DRAFT.
Summary information for the imports that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter. If there are more imports\n available, the nextToken field contains a token to get the\n next page of results.
A token that indicates whether there are more results to return in a\n response to the ListImports operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListImports\n operation request to get the next page of results.
The locale specified in the request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListIntents": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListIntentsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListIntentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get a list of intents that meet the specified criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListIntentsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the intent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the intent.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#IntentSortBy", + "traits": { + "smithy.api#documentation": "Determines the sort order for the response from the\n ListIntents operation. You can choose to sort by the\n intent name or last updated date in either ascending or descending\n order.
Provides the specification of a filter used to limit the intents in\n the response to only those that match the filter specification. You can\n only specify one filter and only one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of intents to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListIntents operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListIntents request to return the next page of results.\n For a complete set of results, call the ListIntents\n operation until the nextToken returned in the response is\n null.
The identifier of the bot that contains the intent.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the intent.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The language and locale of the intents in the list.
" + } + }, + "intentSummaries": { + "target": "com.amazonaws.lexmodelsv2#IntentSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the intents that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n intents available, the nextToken field contains a token to\n get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListIntents operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListIntents\n operation request to get the next page of results.
Gets a list of recommended intents provided by the bot\n recommendation that you can use in your bot. Intents in the \n response are ordered by relevance.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListRecommendedIntentsRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the recommended intents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the recommended\n intents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation that contains the\n recommended intents.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListRecommendedIntents operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListRecommendedIntentsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intent.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the intent.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation that contains the\n recommended intent.
" + } + }, + "summaryList": { + "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the intents that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more intents\n available, the nextToken field contains a token to get the next page of\n results.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListRecommendedIntents operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListRecommendedIntents operation request to get the next page of\n results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListSlotTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListSlotTypesRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListSlotTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of slot types that match the specified criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListSlotTypesRequest": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot that contains the slot\n types.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSortBy", + "traits": { + "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlotTypes operation. You can choose to sort by the\n slot type name or last updated date in either ascending or descending\n order.
Provides the specification of a filter used to limit the slot types\n in the response to only those that match the filter specification. You\n can only specify one filter and only one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of slot types to return in each page of results.\n If there are fewer results than the max page size, only the actual\n number of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", + "traits": { + "smithy.api#documentation": "If the response from the ListSlotTypes operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
The identifier of the bot that contains the slot types.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot types.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The language and local of the slot types in the list.
" + } + }, + "slotTypeSummaries": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the slot types that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n slot types available, the nextToken field contains a token\n to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListSlotTypes operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListSlotTypes\n operation request to get the next page of results.
Gets a list of slots that match the specified criteria.
", + "smithy.api#http": { + "method": "POST", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListSlotsRequest": { "type": "structure", "members": { - "dateRangeFilter": { - "target": "com.amazonaws.lexmodelsv2#DateRangeFilter", + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot that contains the slot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the slots to list. The\n string must match one of the supported locales. For more information,\n see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "intentId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the intent that contains the slot.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#SlotSortBy", + "traits": { + "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlots operation. You can choose to sort by the slot\n name or last updated date in either ascending or descending\n order.
Provides the specification of a filter used to limit the slots in\n the response to only those that match the filter specification. You can\n only specify one filter and only one string to filter on.
" + } + }, + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of slots to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + } + }, + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "The object that contains a date range filter that will be applied to\n the transcript. Specify this object if you want Amazon Lex to only read the\n files that are within the date range.
" + "smithy.api#documentation": "If the response from the ListSlots operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
The object that contains transcript filter details that are\n associated with a bot recommendation.
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ListAggregatedUtterances": { + "com.amazonaws.lexmodelsv2#ListSlotsResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot that contains the slots.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slots.
" + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The language and locale of the slots in the list.
" + } + }, + "intentId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the intent that contains the slots.
" + } + }, + "slotSummaries": { + "target": "com.amazonaws.lexmodelsv2#SlotSummaryList", + "traits": { + "smithy.api#documentation": "Summary information for the slots that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n slots available, the nextToken field contains a token to\n get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListSlots operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListSlots\n operation request to get the next page of results.
Provides a list of utterances that users have sent to the\n bot.
\nUtterances are aggregated by the text of the utterance. For example,\n all instances where customers used the phrase \"I want to order pizza\"\n are aggregated into the same line in the response.
\nYou can see both detected utterances and missed utterances. A\n detected utterance is where the bot properly recognized the utterance\n and activated the associated intent. A missed utterance was not\n recognized by the bot and didn't activate an intent.
\nUtterances can be aggregated for a bot alias or for a bot version,\n but not both at the same time.
\nUtterances statistics are not generated under the following\n conditions:
\nThe childDirected field was set to true when the\n bot was created.
You are using slot obfuscation with one or more slots.
\nYou opted out of participating in improving Amazon Lex.
\nGets a list of tags associated with a resource. Only bots, bot\n aliases, and bot channels can have tags associated with them.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{resourceARN}", + "code": 200 + } + } + }, + "com.amazonaws.lexmodelsv2#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "resourceARN": { + "target": "com.amazonaws.lexmodelsv2#AmazonResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to get a list of tags\n for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", + "traits": { + "smithy.api#documentation": "The tags associated with a resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#ListTestExecutionResultItems": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#ListTestExecutionResultItemsRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#ListTestExecutionResultItemsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets a list of test execution result items.
", "smithy.api#http": { "method": "POST", - "uri": "/bots/{botId}/aggregatedutterances", + "uri": "/testexecutions/{testExecutionId}/results", "code": 200 }, "smithy.api#paginated": { @@ -9865,146 +13234,158 @@ } } }, - "com.amazonaws.lexmodelsv2#ListAggregatedUtterancesRequest": { + "com.amazonaws.lexmodelsv2#ListTestExecutionResultItemsRequest": { "type": "structure", "members": { - "botId": { + "testExecutionId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot associated with this\n request.
", + "smithy.api#documentation": "The unique identifier of the test execution to list the result items.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "botAliasId": { - "target": "com.amazonaws.lexmodelsv2#BotAliasId", + "resultFilterBy": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionResultFilterBy", "traits": { - "smithy.api#documentation": "The identifier of the bot alias associated with this request. If you\n specify the bot alias, you can't specify the bot version.
" + "smithy.api#documentation": "The filter for the list of results from the test set execution.
", + "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", "traits": { - "smithy.api#documentation": "The identifier of the bot version associated with this request. If\n you specify the bot version, you can't specify the bot alias.
" + "smithy.api#documentation": "The maximum number of test execution result items to return in each \n page. If there are fewer results than the max page size, only the actual \n number of results are returned.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "The identifier of the language and locale where the utterances were\n collected. For more information, see Supported\n languages.
", - "smithy.api#required": {} + "smithy.api#documentation": "If the response from the ListTestExecutionResultItems operation \n contains more results than specified in the maxResults parameter, \n a token is returned in the response. Use that token in the nextToken \n parameter to return the next page of results.
The list of results from the test execution.
" } }, - "aggregationDuration": { - "target": "com.amazonaws.lexmodelsv2#UtteranceAggregationDuration", + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "The time window for aggregating the utterance information. You can\n specify a time between one hour and two weeks.
", - "smithy.api#required": {} + "smithy.api#documentation": "A token that indicates whether there are more results to return in a response\n to the ListTestExecutionResultItems operation. If the \n nextToken field is present, you send the contents as the \n nextToken parameter of a ListTestExecutionResultItems \n operation request to get the next page of results.
The list of test set executions.
", + "smithy.api#http": { + "method": "POST", + "uri": "/testexecutions", + "code": 200 }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.lexmodelsv2#ListTestExecutionsRequest": { + "type": "structure", + "members": { "sortBy": { - "target": "com.amazonaws.lexmodelsv2#AggregatedUtterancesSortBy", - "traits": { - "smithy.api#documentation": "Specifies sorting parameters for the list of utterances. You can\n sort by the hit count, the missed count, or the number of distinct\n sessions the utterance appeared in.
" - } - }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#AggregatedUtterancesFilters", + "target": "com.amazonaws.lexmodelsv2#TestExecutionSortBy", "traits": { - "smithy.api#documentation": "Provides the specification of a filter used to limit the utterances\n in the response to only those that match the filter specification. You\n can only specify one filter and one string to filter on.
" + "smithy.api#documentation": "The sort order of the test set executions.
" } }, "maxResults": { "target": "com.amazonaws.lexmodelsv2#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of utterances to return in each page of results.\n If there are fewer results than the maximum page size, only the actual\n number of results are returned. If you don't specify the\n maxResults parameter, 1,000 results are\n returned.
The maximum number of test executions to return in each page. If there are \n fewer results than the max page size, only the actual number of results are \n returned.
" } }, "nextToken": { "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "If the response from the ListAggregatedUtterances\n operation contains more results that specified in the\n maxResults parameter, a token is returned in the\n response. Use that token in the nextToken parameter to\n return the next page of results.
If the response from the ListTestExecutions operation contains more results \n than specified in the maxResults parameter, a token is returned in the response. \n Use that token in the nextToken parameter to return the next page of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ListAggregatedUtterancesResponse": { + "com.amazonaws.lexmodelsv2#ListTestExecutionsResponse": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the utterances.
" - } - }, - "botAliasId": { - "target": "com.amazonaws.lexmodelsv2#BotAliasId", - "traits": { - "smithy.api#documentation": "The identifier of the bot alias that contains the utterances. If you\n specified the bot version, the bot alias ID isn't returned.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The identifier of the bot version that contains the utterances. If\n you specified the bot alias, the bot version isn't returned.
" - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", - "traits": { - "smithy.api#documentation": "The identifier of the language and locale that the utterances are\n in.
" - } - }, - "aggregationDuration": { - "target": "com.amazonaws.lexmodelsv2#UtteranceAggregationDuration", - "traits": { - "smithy.api#documentation": "The time period used to aggregate the utterance data.
" - } - }, - "aggregationWindowStartTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the aggregation window begins. Only data\n collected after this time is returned in the results.
" - } - }, - "aggregationWindowEndTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the aggregation window ends. Only data\n collected between the start time and the end time are returned in the\n results.
" - } - }, - "aggregationLastRefreshedDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", - "traits": { - "smithy.api#documentation": "The last date and time that the aggregated data was collected. The\n time period depends on the length of the aggregation window.
\n\n Hours - for 1 hour time\n window, every half hour; otherwise every hour.
\n\n Days - every 6 hours
\n\n Weeks - for a one week time\n window, every 12 hours; otherwise, every day
\nSummaries of the aggregated utterance data. Each response contains\n information about the number of times that the utterance was seen\n during the time period, whether it was detected or missed, and when it\n was seen during the time period.
" + "smithy.api#documentation": "The list of test executions.
" } }, "nextToken": { "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListAggregatedUtterances operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a\n ListAggregatedUtterances operation request to get the\n next page of results.
A token that indicates whether there are more results to return in a response to \n the ListTestExecutions operation. If the nextToken field is present, you send the \n contents as the nextToken parameter of a ListTestExecutions operation request to \n get the next page of results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ListBotAliases": { + "com.amazonaws.lexmodelsv2#ListTestSetRecords": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#ListBotAliasesRequest" + "target": "com.amazonaws.lexmodelsv2#ListTestSetRecordsRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#ListBotAliasesResponse" + "target": "com.amazonaws.lexmodelsv2#ListTestSetRecordsResponse" }, "errors": [ { "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, { "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" }, @@ -10016,10 +13397,10 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of aliases for the specified bot.
", + "smithy.api#documentation": "The list of test set records.
", "smithy.api#http": { "method": "POST", - "uri": "/bots/{botId}/botaliases", + "uri": "/testsets/{testSetId}/records", "code": 200 }, "smithy.api#paginated": { @@ -10029,13 +13410,13 @@ } } }, - "com.amazonaws.lexmodelsv2#ListBotAliasesRequest": { + "com.amazonaws.lexmodelsv2#ListTestSetRecordsRequest": { "type": "structure", "members": { - "botId": { + "testSetId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The identifier of the bot to list aliases for.
", + "smithy.api#documentation": "The identifier of the test set to list its test set records.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10043,47 +13424,47 @@ "maxResults": { "target": "com.amazonaws.lexmodelsv2#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of aliases to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + "smithy.api#documentation": "The maximum number of test set records to return in each page. If there are \n fewer records than the max page size, only the actual number of records are \n returned.
" } }, "nextToken": { "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "If the response from the ListBotAliases operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
If the response from the ListTestSetRecords operation contains more results \n than specified in the maxResults parameter, a token is returned in the response. \n Use that token in the nextToken parameter to return the next page of results.
" } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ListBotAliasesResponse": { + "com.amazonaws.lexmodelsv2#ListTestSetRecordsResponse": { "type": "structure", "members": { - "botAliasSummaries": { - "target": "com.amazonaws.lexmodelsv2#BotAliasSummaryList", + "testSetRecords": { + "target": "com.amazonaws.lexmodelsv2#TestSetTurnRecordList", "traits": { - "smithy.api#documentation": "Summary information for the bot aliases that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more aliases available, the nextToken field contains a\n token to get the next page of results.
The list of records from the test set.
" } }, "nextToken": { "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotAliases operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
The identifier of the bot associated with the aliases.
" + "smithy.api#documentation": "A token that indicates whether there are more records to return in a response\n to the ListTestSetRecords operation. If the nextToken field is present, you \n send the contents as the nextToken parameter of a ListTestSetRecords operation \n request to get the next page of records.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ListBotLocales": { + "com.amazonaws.lexmodelsv2#ListTestSets": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#ListBotLocalesRequest" + "target": "com.amazonaws.lexmodelsv2#ListTestSetsRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#ListBotLocalesResponse" + "target": "com.amazonaws.lexmodelsv2#ListTestSetsResponse" }, "errors": [ { @@ -10100,10 +13481,10 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of locales for the specified bot.
", + "smithy.api#documentation": "The list of the test sets
", "smithy.api#http": { "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales", + "uri": "/testsets", "code": 200 }, "smithy.api#paginated": { @@ -10113,1020 +13494,1243 @@ } } }, - "com.amazonaws.lexmodelsv2#ListBotLocalesRequest": { + "com.amazonaws.lexmodelsv2#ListTestSetsRequest": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "sortBy": { + "target": "com.amazonaws.lexmodelsv2#TestSetSortBy", "traits": { - "smithy.api#documentation": "The identifier of the bot to list locales for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The sort order for the list of test sets.
" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "maxResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", "traits": { - "smithy.api#documentation": "The version of the bot to list locales for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The maximum number of test sets to return in each page. If there are fewer \n results than the max page size, only the actual number of results are returned.
" } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#BotLocaleSortBy", + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "Specifies sorting parameters for the list of locales. You can sort\n by locale name in ascending or descending order.
" + "smithy.api#documentation": "If the response from the ListTestSets operation contains more results than \n specified in the maxResults parameter, a token is returned in the response. Use \n that token in the nextToken parameter to return the next page of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#ListTestSetsResponse": { + "type": "structure", + "members": { + "testSets": { + "target": "com.amazonaws.lexmodelsv2#TestSetSummaryList", + "traits": { + "smithy.api#documentation": "The selected test sets in a list of test sets.
" } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#BotLocaleFilters", + "nextToken": { + "target": "com.amazonaws.lexmodelsv2#NextToken", "traits": { - "smithy.api#documentation": "Provides the specification for a filter used to limit the response\n to only those locales that match the filter specification. You can only\n specify one filter and one value to filter on.
" + "smithy.api#documentation": "A token that indicates whether there are more results to return in a response \n to the ListTestSets operation. If the nextToken field is present, you send the \n contents as the nextToken parameter of a ListTestSets operation request to get \n the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#LocaleId": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#LocaleName": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#LogPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.lexmodelsv2#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.lexmodelsv2#MaxUtteranceDigits": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.lexmodelsv2#MergeStrategy": { + "type": "enum", + "members": { + "Overwrite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Overwrite" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "FailOnConflict": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The maximum number of aliases to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + "smithy.api#enumValue": "FailOnConflict" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "Append": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If the response from the ListBotLocales operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token as the\n nextToken parameter to return the next page of results.\n
The identifier of the bot to list locales for.
" + "smithy.api#documentation": "A message in plain text format.
" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "customPayload": { + "target": "com.amazonaws.lexmodelsv2#CustomPayload", "traits": { - "smithy.api#documentation": "The version of the bot.
" + "smithy.api#documentation": "A message in a custom format defined by the client\n application.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "ssmlMessage": { + "target": "com.amazonaws.lexmodelsv2#SSMLMessage", + "traits": { + "smithy.api#documentation": "A message in Speech Synthesis Markup Language (SSML).
" + } + }, + "imageResponseCard": { + "target": "com.amazonaws.lexmodelsv2#ImageResponseCard", + "traits": { + "smithy.api#documentation": "A message that defines a response card that the client application\n can show to the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The object that provides message text and its type.
" + } + }, + "com.amazonaws.lexmodelsv2#MessageGroup": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.lexmodelsv2#Message", + "traits": { + "smithy.api#documentation": "The primary message that Amazon Lex should send to the user.
", + "smithy.api#required": {} + } + }, + "variations": { + "target": "com.amazonaws.lexmodelsv2#MessageVariationsList", + "traits": { + "smithy.api#documentation": "Message variations to send to the user. When variations are defined,\n Amazon Lex chooses the primary message or one of the variations to send to\n the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides one or more messages that Amazon Lex should send to the\n user.
" + } + }, + "com.amazonaws.lexmodelsv2#MessageGroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#MessageGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.lexmodelsv2#MessageSelectionStrategy": { + "type": "enum", + "members": { + "Random": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotLocales operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotLocales\n operation request to get the next page of results.
Summary information for the locales that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n locales available, the nextToken field contains a token to\n get the next page of results.
Get a list of bot recommendations that meet the specified\n criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#length": { + "min": 0, + "max": 2 } } }, - "com.amazonaws.lexmodelsv2#ListBotRecommendationsRequest": { + "com.amazonaws.lexmodelsv2#MissedCount": { + "type": "integer" + }, + "com.amazonaws.lexmodelsv2#MultipleValuesSetting": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "allowMultipleValues": { + "target": "com.amazonaws.lexmodelsv2#Boolean", "traits": { - "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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.
Indicates whether a slot can return multiple values.
" + } + }, + "com.amazonaws.lexmodelsv2#Name": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" + } + }, + "com.amazonaws.lexmodelsv2#NewCustomVocabularyItem": { + "type": "structure", + "members": { + "phrase": { + "target": "com.amazonaws.lexmodelsv2#Phrase", "traits": { - "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The unique phrase for the new custom vocabulary item from the custom \n vocabulary list.
", "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "weight": { + "target": "com.amazonaws.lexmodelsv2#Weight", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The weight assigned to the new custom vocabulary item from the custom \n vocabulary list.
" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "displayAs": { + "target": "com.amazonaws.lexmodelsv2#Phrase", "traits": { - "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + "smithy.api#documentation": "The display as value assigned to the new custom vocabulary item from the custom \n vocabulary list.
" } + } + }, + "traits": { + "smithy.api#documentation": "The new custom vocabulary item from the custom \n vocabulary list.
" + } + }, + "com.amazonaws.lexmodelsv2#NextIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 10000000 + } + } + }, + "com.amazonaws.lexmodelsv2#NextToken": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.lexmodelsv2#NumericalBotVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.lexmodelsv2#ObfuscationSetting": { + "type": "structure", + "members": { + "obfuscationSettingType": { + "target": "com.amazonaws.lexmodelsv2#ObfuscationSettingType", "traits": { - "smithy.api#documentation": "If the response from the ListBotRecommendation operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + "smithy.api#documentation": "Value that determines whether Amazon Lex obscures slot values in\n conversation logs. The default is to obscure the values.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Determines whether Amazon Lex obscures slot values in conversation logs.\n
" } }, - "com.amazonaws.lexmodelsv2#ListBotRecommendationsResponse": { - "type": "structure", + "com.amazonaws.lexmodelsv2#ObfuscationSettingType": { + "type": "enum", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "None": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier of the bot that contains the bot\n recommendation list.
" + "smithy.api#enumValue": "None" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "DefaultObfuscation": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the bot that contains the bot recommendation\n list.
" + "smithy.api#enumValue": "DefaultObfuscation" } + } + } + }, + "com.amazonaws.lexmodelsv2#ObjectPrefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "smithy.api#pattern": "^[\\/]?+[a-zA-Z0-9!_.*'()-]+(\\/[a-zA-Z0-9!_.*'()-]+)*$" + } + }, + "com.amazonaws.lexmodelsv2#ObjectPrefixes": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ObjectPrefix" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.lexmodelsv2#Operation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 50 + }, + "smithy.api#pattern": "^lex:[a-zA-Z*]+$" + } + }, + "com.amazonaws.lexmodelsv2#OperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#Operation" + } + }, + "com.amazonaws.lexmodelsv2#OutputContext": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n list.
" + "smithy.api#documentation": "The name of the output context.
", + "smithy.api#required": {} } }, - "botRecommendationSummaries": { - "target": "com.amazonaws.lexmodelsv2#BotRecommendationSummaryList", + "timeToLiveInSeconds": { + "target": "com.amazonaws.lexmodelsv2#ContextTimeToLiveInSeconds", "traits": { - "smithy.api#documentation": "Summary information for the bot recommendations that meet the filter\n specified in this request. The length of the list is specified in the\n maxResults parameter of the request. If there are more bot\n recommendations available, the nextToken field contains a token to get\n the next page of results.
" + "smithy.api#documentation": "The amount of time, in seconds, that the output context should\n remain active. The time is figured from the first time the context is\n sent to the user.
", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "turnsToLive": { + "target": "com.amazonaws.lexmodelsv2#ContextTurnsToLive", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotRecommendations operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListBotRecommendations operation request to get the next page of\n results.
" + "smithy.api#documentation": "The number of conversation turns that the output context should\n remain active. The number of turns is counted from the first time that\n the context is sent to the user.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Describes a session context that is activated when an intent is\n fulfilled.
" } }, - "com.amazonaws.lexmodelsv2#ListBotVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListBotVersionsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListBotVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], + "com.amazonaws.lexmodelsv2#OutputContextsList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#OutputContext" + }, "traits": { - "smithy.api#documentation": "Gets information about all of the versions of a bot.
\nThe ListBotVersions operation returns a summary of each\n version of a bot. For example, if a bot has three numbered versions,\n the ListBotVersions operation returns for summaries, one\n for each numbered version and one for the DRAFT\n version.
The ListBotVersions operation always returns at least\n one version, the DRAFT version.
The identifier of the bot to list versions for.
", - "smithy.api#httpLabel": {}, + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether the conversation contains multiple turns or not.
", "smithy.api#required": {} } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#BotVersionSortBy", + "totalResultCount": { + "target": "com.amazonaws.lexmodelsv2#Count", "traits": { - "smithy.api#documentation": "Specifies sorting parameters for the list of versions. You can\n specify that the list be sorted by version name in either ascending or\n descending order.
" + "smithy.api#documentation": "The total number of overall results in the result of the test execution.
", + "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "speechTranscriptionResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", "traits": { - "smithy.api#documentation": "The maximum number of versions to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + "smithy.api#documentation": "The number of speech transcription results in the overall test.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "endToEndResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", "traits": { - "smithy.api#documentation": "If the response to the ListBotVersion operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
The number of results that succeeded.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Information about the overall results for a test execution result.
" } }, - "com.amazonaws.lexmodelsv2#ListBotVersionsResponse": { + "com.amazonaws.lexmodelsv2#OverallTestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#OverallTestResultItem" + } + }, + "com.amazonaws.lexmodelsv2#OverallTestResults": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.lexmodelsv2#OverallTestResultItemList", + "traits": { + "smithy.api#documentation": "A list of the overall test results.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the overall test results.
" + } + }, + "com.amazonaws.lexmodelsv2#ParentBotNetwork": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The identifier of the bot to list versions for.
" + "smithy.api#documentation": "The identifier of the network of bots assigned by Amazon Lex.
", + "smithy.api#required": {} } }, - "botVersionSummaries": { - "target": "com.amazonaws.lexmodelsv2#BotVersionSummaryList", + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#BotVersion", "traits": { - "smithy.api#documentation": "Summary information for the bot versions that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more versions available, the nextToken field contains a\n token to get the next page of results.
The version of the network of bots.
", + "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + } + }, + "traits": { + "smithy.api#documentation": "A network of bots.
" + } + }, + "com.amazonaws.lexmodelsv2#ParentBotNetworks": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#ParentBotNetwork" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.lexmodelsv2#PathFormat": { + "type": "structure", + "members": { + "objectPrefixes": { + "target": "com.amazonaws.lexmodelsv2#ObjectPrefixes", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBotVersions operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3\n bucket. Specify this list if you only want Lex to read the files under\n this set of sub-folders.
" } } + }, + "traits": { + "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" } }, - "com.amazonaws.lexmodelsv2#ListBots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListBotsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListBotsResponse" + "com.amazonaws.lexmodelsv2#Phrase": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.lexmodelsv2#PlainTextMessage": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.lexmodelsv2#PlainTextMessageValue", + "traits": { + "smithy.api#documentation": "The message to send to the user.
", + "smithy.api#required": {} + } + } }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" + "traits": { + "smithy.api#documentation": "Defines an ASCII text message to send to the user.
" + } + }, + "com.amazonaws.lexmodelsv2#PlainTextMessageValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 } - ], + } + }, + "com.amazonaws.lexmodelsv2#Policy": { + "type": "string", "traits": { - "smithy.api#documentation": "Gets a list of available bots.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#length": { + "min": 2 } } }, - "com.amazonaws.lexmodelsv2#ListBotsRequest": { + "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification": { "type": "structure", "members": { - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#BotSortBy", + "successResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "successNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "Specifies sorting parameters for the list of bots. You can specify\n that the list be sorted by bot name in ascending or descending\n order.
" + "smithy.api#documentation": "Specifics the next step the bot runs after the dialog code hook\n finishes successfully.
" } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#BotFilters", + "successConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", "traits": { - "smithy.api#documentation": "Provides the specification of a filter used to limit the bots in the\n response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" + "smithy.api#documentation": "A list of conditional branches to evaluate after the dialog code\n hook finishes successfully.
" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "The maximum number of bots to return in each page of results. If\n there are fewer results than the maximum page size, only the actual\n number of results are returned.
" + "smithy.api#documentation": "Specifies the next step the bot runs after the dialog code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.
If the response from the ListBots operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListBots request to return the next page of results.\n For a complete set of results, call the ListBots operation\n until the nextToken returned in the response is\n null.
A list of conditional branches to evaluate after the dialog code\n hook throws an exception or returns with the State field\n of the Intent object set to Failed.
Summary information for the bots that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n bots available, the nextToken field contains a token to\n the next page of results.
Specifies the next step that the bot runs when the code hook times\n out.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "timeoutConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBots operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBots\n operation request to get the next page of results.
A list of conditional branches to evaluate if the code hook times\n out.
" } } + }, + "traits": { + "smithy.api#documentation": "Specifies next steps to run after the dialog code hook\n finishes.
" } }, - "com.amazonaws.lexmodelsv2#ListBuiltInIntents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListBuiltInIntentsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListBuiltInIntentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" + "com.amazonaws.lexmodelsv2#PostFulfillmentStatusSpecification": { + "type": "structure", + "members": { + "successResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + "timeoutResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Gets a list of built-in intents provided by Amazon Lex that you can use\n in your bot.
\nTo use a built-in intent as a the base for your own intent, include\n the built-in intent signature in the parentIntentSignature\n parameter when you call the CreateIntent operation. For\n more information, see CreateIntent.
Specifies the next step in the conversation that Amazon Lex\n invokes when the fulfillment code hook completes successfully.
" + } + }, + "successConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "traits": { + "smithy.api#documentation": "A list of conditional branches to evaluate after the fulfillment\n code hook finishes successfully.
" + } }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.lexmodelsv2#ListBuiltInIntentsRequest": { - "type": "structure", - "members": { - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the next step the bot runs after the fulfillment code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.
Specifies sorting parameters for the list of built-in intents. You\n can specify that the list be sorted by the built-in intent signature in\n either ascending or descending order.
" + "smithy.api#documentation": "A list of conditional branches to evaluate after the fulfillment\n code hook throws an exception or returns with the State\n field of the Intent object set to\n Failed.
The maximum number of built-in intents to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + "smithy.api#documentation": "Specifies the next step that the bot runs when the fulfillment code\n hook times out.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "timeoutConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", "traits": { - "smithy.api#documentation": "If the response from the ListBuiltInIntents operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
A list of conditional branches to evaluate if the fulfillment code\n hook times out.
" } } + }, + "traits": { + "smithy.api#documentation": "Provides a setting that determines whether the post-fulfillment\n response is sent to the user. For more information, see https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete\n
" } }, - "com.amazonaws.lexmodelsv2#ListBuiltInIntentsResponse": { + "com.amazonaws.lexmodelsv2#PreconditionFailedException": { "type": "structure", "members": { - "builtInIntentSummaries": { - "target": "com.amazonaws.lexmodelsv2#BuiltInIntentSummaryList", - "traits": { - "smithy.api#documentation": "Summary information for the built-in intents that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more intents available, the nextToken field contains a\n token to get the next page of results.
Your request couldn't be completed because one or more request\n fields aren't valid. Check the fields in your request and try\n again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 412 + } + }, + "com.amazonaws.lexmodelsv2#PresignedS3Url": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.lexmodelsv2#Principal": { + "type": "structure", + "members": { + "service": { + "target": "com.amazonaws.lexmodelsv2#ServicePrincipal", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBuiltInIntents operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListBotAliases\n operation request to get the next page of results.
The name of the Amazon Web Services service that should allowed or denied access to\n an Amazon Lex action.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "arn": { + "target": "com.amazonaws.lexmodelsv2#PrincipalArn", "traits": { - "smithy.api#documentation": "The language and locale of the intents in the list.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal.
" } } + }, + "traits": { + "smithy.api#documentation": "The IAM principal that you allowing or denying access to an Amazon Lex\n action. You must provide a service or an arn,\n but not both in the same statement. For more information, see AWS JSON policy elements: Principal .
Gets a list of built-in slot types that meet the specified\n criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/builtins/locales/{localeId}/slottypes", - "code": 200 + "smithy.api#length": { + "min": 30, + "max": 1024 }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:(root|(user|role)/.*)$" + } + }, + "com.amazonaws.lexmodelsv2#PrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#Principal" + } + }, + "com.amazonaws.lexmodelsv2#PriorityValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 } } }, - "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypesRequest": { - "type": "structure", + "com.amazonaws.lexmodelsv2#PromptAttempt": { + "type": "enum", "members": { - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "Initial": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "Initial" } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#BuiltInSlotTypeSortBy", + "Retry1": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Determines the sort order for the response from the\n ListBuiltInSlotTypes operation. You can choose to sort\n by the slot type signature in either ascending or descending\n order.
The maximum number of built-in slot types to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + "smithy.api#enumValue": "Retry2" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "Retry3": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If the response from the ListBuiltInSlotTypes operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
The attempt name of attempts of a prompt.
" } }, - "com.amazonaws.lexmodelsv2#ListBuiltInSlotTypesResponse": { + "com.amazonaws.lexmodelsv2#PromptAttemptSpecification": { "type": "structure", "members": { - "builtInSlotTypeSummaries": { - "target": "com.amazonaws.lexmodelsv2#BuiltInSlotTypeSummaryList", + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "Summary information for the built-in slot types that meet the filter\n criteria specified in the request. The length of the list is specified\n in the maxResults parameter of the request. If there are\n more slot types available, the nextToken field contains a\n token to get the next page of results.
Indicates whether the user can interrupt a speech prompt attempt from the bot.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "allowedInputTypes": { + "target": "com.amazonaws.lexmodelsv2#AllowedInputTypes", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListBuiltInSlotTypes operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a\n LIstBuiltInSlotTypes operation request to get the next\n page of results.
Indicates the allowed input types of the prompt attempt.
", + "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "audioAndDTMFInputSpecification": { + "target": "com.amazonaws.lexmodelsv2#AudioAndDTMFInputSpecification", "traits": { - "smithy.api#documentation": "The language and locale of the slot types in the list.
" + "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#ListCustomVocabularyItems": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsResponse" + "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#PromptAttempt" }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Paginated list of custom vocabulary items for a given bot locale's \n custom vocabulary.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/customvocabulary/DEFAULT/list", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "value": { + "target": "com.amazonaws.lexmodelsv2#PromptAttemptSpecification" + } + }, + "com.amazonaws.lexmodelsv2#PromptMaxRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 5 } } }, - "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsRequest": { + "com.amazonaws.lexmodelsv2#PromptSpecification": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "messageGroups": { + "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with this custom \n vocabulary.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "A collection of messages that Amazon Lex can send to the user. Amazon Lex\n chooses the actual message to send at runtime.
", "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "maxRetries": { + "target": "com.amazonaws.lexmodelsv2#PromptMaxRetries", "traits": { - "smithy.api#documentation": "The bot version of the bot to the list custom vocabulary \n request.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The maximum number of times the bot tries to elicit a response from\n the user using this prompt.
", "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "The identifier of the language and locale where this custom vocabulary \n is used. The string must match one of the supported locales. For more \n information, see Supported \n languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Indicates whether the user can interrupt a speech prompt from the\n bot.
" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "messageSelectionStrategy": { + "target": "com.amazonaws.lexmodelsv2#MessageSelectionStrategy", "traits": { - "smithy.api#documentation": "The maximum number of items returned by the list operation.
" + "smithy.api#documentation": "Indicates how a message is selected from a message group among retries.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "promptAttemptsSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap", "traits": { - "smithy.api#documentation": "The nextToken identifier to the list custom vocabulary \n request.
" + "smithy.api#documentation": "Specifies the advanced settings on each attempt of the prompt.
" } } + }, + "traits": { + "smithy.api#documentation": "Specifies a list of message groups that Amazon Lex sends to a user to\n elicit a response.
" } }, - "com.amazonaws.lexmodelsv2#ListCustomVocabularyItemsResponse": { + "com.amazonaws.lexmodelsv2#QueryFilterString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.lexmodelsv2#RecommendedAction": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#RecommendedAction" + } + }, + "com.amazonaws.lexmodelsv2#RecommendedIntentSummary": { "type": "structure", "members": { - "botId": { + "intentId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The identifier of the bot associated with this custom vocabulary.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The identifier of the version of the bot associated with this custom \n vocabulary.
" - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", - "traits": { - "smithy.api#documentation": "The identifier of the language and locale where this custom vocabulary \n is used. The string must match one of the supported locales. For more \n information, see Supported Languages .
" + "smithy.api#documentation": "The unique identifier of a recommended intent associated with the\n bot recommendation.
" } }, - "customVocabularyItems": { - "target": "com.amazonaws.lexmodelsv2#CustomVocabularyItems", + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The custom vocabulary items from the list custom vocabulary \n response.
" + "smithy.api#documentation": "The name of a recommended intent associated with the bot\n recommendation.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "sampleUtterancesCount": { + "target": "com.amazonaws.lexmodelsv2#SampleUtterancesCount", "traits": { - "smithy.api#documentation": "The nextToken identifier to the list custom vocabulary \n response.
" + "smithy.api#documentation": "The count of sample utterances of a recommended intent that is\n associated with a bot recommendation.
" } } + }, + "traits": { + "smithy.api#documentation": "An object that contains a summary of a recommended intent.
" } }, - "com.amazonaws.lexmodelsv2#ListExports": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListExportsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListExportsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" + "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummary" + } + }, + "com.amazonaws.lexmodelsv2#RecordNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200000 } - ], + } + }, + "com.amazonaws.lexmodelsv2#RegexPattern": { + "type": "string", "traits": { - "smithy.api#documentation": "Lists the exports for a bot, bot locale, or custom vocabulary.\n Exports are kept in the list for 7 days.
", - "smithy.api#http": { - "method": "POST", - "uri": "/exports", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#length": { + "min": 1, + "max": 300 } } }, - "com.amazonaws.lexmodelsv2#ListExportsRequest": { + "com.amazonaws.lexmodelsv2#RelativeAggregationDuration": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the bot.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot to list exports for.
" - } - }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#ExportSortBy", - "traits": { - "smithy.api#documentation": "Determines the field that the list of exports is sorted by. You can\n sort by the LastUpdatedDateTime field in ascending or\n descending order.
Provides the specification of a filter used to limit the exports in\n the response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" - } - }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of exports to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" - } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "timeDimension": { + "target": "com.amazonaws.lexmodelsv2#TimeDimension", "traits": { - "smithy.api#documentation": "If the response from the ListExports operation contains\n more results that specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListExports request to return the next page of results.\n For a complete set of results, call the ListExports\n operation until the nextToken returned in the response is\n null.
The type of time period that the timeValue field\n represents.
Specifies the resources that should be exported. If you\n don't specify a resource type in the filters parameter,\n both bot locales and custom vocabularies are exported.
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
Specifies the time window that utterance statistics are returned\n for. The time window is always relative to the last time that the that\n utterances were aggregated. For example, if the\n ListAggregatedUtterances operation is called at 1600,\n the time window is set to 1 hour, and the last refresh time was 1530,\n only utterances made between 1430 and 1530 are returned.
You can choose the time window that statistics should be returned\n for.
\n\n Hours - You can request\n utterance statistics for 1, 3, 6, 12, or 24 hour time windows.\n Statistics are refreshed every half hour for 1 hour time windows,\n and hourly for the other time windows.
\n\n Days - You can request\n utterance statistics for 3 days. Statistics are refreshed every 6\n hours.
\n\n Weeks - You can see\n statistics for one or two weeks. Statistics are refreshed every\n 12 hours for one week time windows, and once per day for two week\n time windows.
\nYou asked to describe a resource that doesn't exist. Check the\n resource that you are requesting and try again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.lexmodelsv2#ResponseSpecification": { + "type": "structure", + "members": { + "messageGroups": { + "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", "traits": { - "smithy.api#documentation": "The unique identifier assigned to the bot by Amazon Lex.
" + "smithy.api#documentation": "A collection of responses that Amazon Lex can send to the user. Amazon Lex\n chooses the actual response to send at runtime.
", + "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", "traits": { - "smithy.api#documentation": "The version of the bot that was exported.
" + "smithy.api#documentation": "Indicates whether the user can interrupt a speech response from\n Amazon Lex.
" } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a list of message groups that Amazon Lex uses to respond the\n user input.
" + } + }, + "com.amazonaws.lexmodelsv2#RetryAfterSeconds": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.lexmodelsv2#RevisionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 }, - "exportSummaries": { - "target": "com.amazonaws.lexmodelsv2#ExportSummaryList", - "traits": { - "smithy.api#documentation": "Summary information for the exports that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter. If there are more exports\n available, the nextToken field contains a token to get the\n next page of results.
A token that indicates whether there are more results to return in a\n response to the ListExports operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListExports\n operation request to get the next page of results.
One or more strings that Amazon Lex should look for in the input to the\n bot. Each phrase is given preference when deciding on slot\n values.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "subSlotHints": { + "target": "com.amazonaws.lexmodelsv2#SlotHintsSlotMap", "traits": { - "smithy.api#documentation": "The locale specified in the request.
" + "smithy.api#documentation": "A map of constituent sub slot names inside a composite slot in the intent and the phrases \n that should be added for each sub slot. Inside each composite slot hints, this structure provides \n a mechanism to add granular sub slot phrases. Only sub slot hints are supported for composite slots. \n The intent name, composite slot name and the constituent sub slot names must exist.
" } } + }, + "traits": { + "smithy.api#documentation": "Provides an array of phrases that should be given preference when\n resolving values for a slot.
" } }, - "com.amazonaws.lexmodelsv2#ListImports": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListImportsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListImportsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], + "com.amazonaws.lexmodelsv2#RuntimeHintPhrase": { + "type": "string", "traits": { - "smithy.api#documentation": "Lists the imports for a bot, bot locale, or custom vocabulary.\n Imports are kept in the list for 7 days.
", - "smithy.api#http": { - "method": "POST", - "uri": "/imports", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#length": { + "min": 1, + "max": 140 } } }, - "com.amazonaws.lexmodelsv2#ListImportsRequest": { + "com.amazonaws.lexmodelsv2#RuntimeHintValue": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier that Amazon Lex assigned to the bot.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot to list imports for.
" - } - }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#ImportSortBy", - "traits": { - "smithy.api#documentation": "Determines the field that the list of imports is sorted by. You can\n sort by the LastUpdatedDateTime field in ascending or\n descending order.
Provides the specification of a filter used to limit the bots in the\n response to only those that match the filter specification. You can\n only specify one filter and one string to filter on.
" - } - }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of imports to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" - } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", - "traits": { - "smithy.api#documentation": "If the response from the ListImports operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListImports request to return the next page of results.\n For a complete set of results, call the ListImports\n operation until the nextToken returned in the response is\n null.
Specifies the locale that should be present in the list. If you\n don't specify a resource type in the filters parameter,\n the list contains both bot locales and custom vocabularies.
The phrase that Amazon Lex should look for in the user's input to the\n bot.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Provides the phrase that Amazon Lex should look for in the user's input\n to the bot.
" } }, - "com.amazonaws.lexmodelsv2#ListImportsResponse": { + "com.amazonaws.lexmodelsv2#RuntimeHintValuesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#RuntimeHintValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.lexmodelsv2#RuntimeHints": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier assigned by Amazon Lex to the bot.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "slotHints": { + "target": "com.amazonaws.lexmodelsv2#SlotHintsIntentMap", "traits": { - "smithy.api#documentation": "The version of the bot that was imported. It will always be\n DRAFT.
A list of the slots in the intent that should have runtime hints\n added, and the phrases that should be added for each slot.
\nThe first level of the slotHints map is the name of the\n intent. The second level is the name of the slot within the intent. For\n more information, see Using hints to improve\n accuracy.
The intent name and slot name must exist.
" } + } + }, + "traits": { + "smithy.api#documentation": "You can provide Amazon Lex with hints to the phrases that a customer is\n likely to use for a slot. When a slot with hints is resolved, the\n phrases in the runtime hints are preferred in the resolution. You can\n provide hints for a maximum of 100 intents. You can provide a maximum\n of 100 slots.
\nBefore you can use runtime hints with an existing bot, you must\n first rebuild the bot.
\nFor more information, see Using runtime hints to\n improve recognition of slot values.
" + } + }, + "com.amazonaws.lexmodelsv2#S3BucketArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 }, - "importSummaries": { - "target": "com.amazonaws.lexmodelsv2#ImportSummaryList", + "smithy.api#pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, + "com.amazonaws.lexmodelsv2#S3BucketLogDestination": { + "type": "structure", + "members": { + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", "traits": { - "smithy.api#documentation": "Summary information for the imports that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter. If there are more imports\n available, the nextToken field contains a token to get the\n next page of results.
The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service\n (KMS) key for encrypting audio log files stored in an S3 bucket.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "s3BucketArn": { + "target": "com.amazonaws.lexmodelsv2#S3BucketArn", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListImports operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListImports\n operation request to get the next page of results.
The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio\n log files are stored.
", + "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "logPrefix": { + "target": "com.amazonaws.lexmodelsv2#LogPrefix", "traits": { - "smithy.api#documentation": "The locale specified in the request.
" + "smithy.api#documentation": "The S3 prefix to assign to audio log files.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Specifies an Amazon S3 bucket for logging audio conversations
" } }, - "com.amazonaws.lexmodelsv2#ListIntents": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListIntentsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListIntentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], + "com.amazonaws.lexmodelsv2#S3BucketName": { + "type": "string", "traits": { - "smithy.api#documentation": "Get a list of intents that meet the specified criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents", - "code": 200 + "smithy.api#length": { + "min": 3, + "max": 63 }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" } }, - "com.amazonaws.lexmodelsv2#ListIntentsRequest": { + "com.amazonaws.lexmodelsv2#S3BucketTranscriptSource": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", "traits": { - "smithy.api#documentation": "The unique identifier of the bot that contains the intent.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The name of the bucket containing the transcript and the associated\n metadata.
", "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "pathFormat": { + "target": "com.amazonaws.lexmodelsv2#PathFormat", "traits": { - "smithy.api#documentation": "The version of the bot that contains the intent.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "transcriptFormat": { + "target": "com.amazonaws.lexmodelsv2#TranscriptFormat", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The format of the transcript content. Currently, Genie only supports\n the Amazon Lex transcript format.
", "smithy.api#required": {} } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#IntentSortBy", + "transcriptFilter": { + "target": "com.amazonaws.lexmodelsv2#TranscriptFilter", "traits": { - "smithy.api#documentation": "Determines the sort order for the response from the\n ListIntents operation. You can choose to sort by the\n intent name or last updated date in either ascending or descending\n order.
The object that contains the filter which will be applied when Amazon Lex\n reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to\n read only a subset of the Amazon S3 bucket based on the filter you\n provide.
" } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#IntentFilters", + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", "traits": { - "smithy.api#documentation": "Provides the specification of a filter used to limit the intents in\n the response to only those that match the filter specification. You can\n only specify one filter and only one string to filter on.
" + "smithy.api#documentation": "The ARN of the KMS key that customer use to encrypt their Amazon S3\n bucket. Only use this field if your bucket is encrypted using a\n customer managed KMS key.
" } + } + }, + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + } + }, + "com.amazonaws.lexmodelsv2#S3ObjectPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, + "com.amazonaws.lexmodelsv2#SSMLMessage": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.lexmodelsv2#SSMLMessageValue", "traits": { - "smithy.api#documentation": "The maximum number of intents to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" + "smithy.api#documentation": "The SSML text that defines the prompt.
", + "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + } + }, + "traits": { + "smithy.api#documentation": "Defines a Speech Synthesis Markup Language (SSML) prompt.
" + } + }, + "com.amazonaws.lexmodelsv2#SSMLMessageValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.lexmodelsv2#SampleUtterance": { + "type": "structure", + "members": { + "utterance": { + "target": "com.amazonaws.lexmodelsv2#Utterance", "traits": { - "smithy.api#documentation": "If the response from the ListIntents operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response.
Use the returned token in the nextToken parameter of a\n ListIntents request to return the next page of results.\n For a complete set of results, call the ListIntents\n operation until the nextToken returned in the response is\n null.
The sample utterance that Amazon Lex uses to build its machine-learning\n model to recognize intents.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "A sample utterance that invokes an intent or respond to a slot\n elicitation prompt.
" } }, - "com.amazonaws.lexmodelsv2#ListIntentsResponse": { + "com.amazonaws.lexmodelsv2#SampleUtterancesCount": { + "type": "integer" + }, + "com.amazonaws.lexmodelsv2#SampleUtterancesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SampleUtterance" + } + }, + "com.amazonaws.lexmodelsv2#SampleValue": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the intent.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot that contains the intent.
" - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", - "traits": { - "smithy.api#documentation": "The language and locale of the intents in the list.
" - } - }, - "intentSummaries": { - "target": "com.amazonaws.lexmodelsv2#IntentSummaryList", - "traits": { - "smithy.api#documentation": "Summary information for the intents that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n intents available, the nextToken field contains a token to\n get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListIntents operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListIntents\n operation request to get the next page of results.
The value that can be used for a slot type.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Defines one of the values for a slot type.
" } }, - "com.amazonaws.lexmodelsv2#ListRecommendedIntents": { + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntentsRequest" + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#ListRecommendedIntentsResponse" + "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsResponse" }, "errors": [ { @@ -11146,34 +14750,29 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of recommended intents provided by the bot\n recommendation that you can use in your bot. Intents in the \n response are ordered by relevance.
", + "smithy.api#documentation": "Search for associated transcripts that meet the specified\n criteria.
", "smithy.api#http": { "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/intents", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts", "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" } } }, - "com.amazonaws.lexmodelsv2#ListRecommendedIntentsRequest": { + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intents.
", + "smithy.api#documentation": "The unique identifier of the bot associated with the transcripts\n that you are searching.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "target": "com.amazonaws.lexmodelsv2#BotVersion", "traits": { - "smithy.api#documentation": "The version of the bot that contains the recommended intents.
", + "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11181,7 +14780,7 @@ "localeId": { "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the recommended\n intents.
", + "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11189,15 +14788,22 @@ "botRecommendationId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The identifier of the bot recommendation that contains the\n recommended intents.
", + "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "searchOrder": { + "target": "com.amazonaws.lexmodelsv2#SearchOrder", "traits": { - "smithy.api#documentation": "If the response from the ListRecommendedIntents operation contains\n more results than specified in the maxResults parameter, a token is\n returned in the response. Use that token in the nextToken parameter to\n return the next page of results.
" + "smithy.api#documentation": "How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
" + } + }, + "filters": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilters", + "traits": { + "smithy.api#documentation": "A list of filter objects.
", + "smithy.api#required": {} } }, "maxResults": { @@ -11205,1424 +14811,1373 @@ "traits": { "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" } + }, + "nextIndex": { + "target": "com.amazonaws.lexmodelsv2#NextIndex", + "traits": { + "smithy.api#documentation": "If the response from the SearchAssociatedTranscriptsRequest\n operation contains more results than specified in the maxResults\n parameter, an index is returned in the response. Use that index in the\n nextIndex parameter to return the next page of results.
" + } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#ListRecommendedIntentsResponse": { + "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsResponse": { "type": "structure", "members": { "botId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot associated with the recommended\n intent.
" + "smithy.api#documentation": "The unique identifier of the bot associated with the transcripts\n that you are searching.
" } }, "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "target": "com.amazonaws.lexmodelsv2#BotVersion", "traits": { - "smithy.api#documentation": "The version of the bot that contains the intent.
" + "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
" } }, "localeId": { "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the intents to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
" + "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
" } }, "botRecommendationId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The identifier of the bot recommendation that contains the\n recommended intent.
" + "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
" } }, - "summaryList": { - "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList", + "nextIndex": { + "target": "com.amazonaws.lexmodelsv2#NextIndex", "traits": { - "smithy.api#documentation": "Summary information for the intents that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more intents\n available, the nextToken field contains a token to get the next page of\n results.
" + "smithy.api#documentation": "A index that indicates whether there are more results to return in a\n response to the SearchAssociatedTranscripts operation. If the nextIndex\n field is present, you send the contents as the nextIndex parameter of a\n SearchAssociatedTranscriptsRequest operation to get the next page of\n results.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "associatedTranscripts": { + "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptList", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListRecommendedIntents operation. If the nextToken\n field is present, you send the contents as the nextToken parameter of a\n ListRecommendedIntents operation request to get the next page of\n results.
" + "smithy.api#documentation": "The object that contains the associated transcript that meet the\n criteria you specified.
" + } + }, + "totalResults": { + "target": "com.amazonaws.lexmodelsv2#MaxResults", + "traits": { + "smithy.api#documentation": "The total number of transcripts returned by the search.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ListSlotTypes": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListSlotTypesRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListSlotTypesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + "com.amazonaws.lexmodelsv2#SearchOrder": { + "type": "enum", + "members": { + "Ascending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ascending" + } }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + "Descending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Descending" + } + } + } + }, + "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings": { + "type": "structure", + "members": { + "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": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of\n user utterances.
" + } + }, + "com.amazonaws.lexmodelsv2#ServicePrincipal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 1024 }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" + "smithy.api#pattern": "^[0-9a-zA-Z_.]+$" + } + }, + "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.lexmodelsv2#ExceptionMessage" } - ], + }, "traits": { - "smithy.api#documentation": "Gets a list of slot types that match the specified criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes", - "code": 200 + "smithy.api#documentation": "You have reached a quota for your bot.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.lexmodelsv2#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 100 }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + } + }, + "com.amazonaws.lexmodelsv2#SessionTTL": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 86400 } } }, - "com.amazonaws.lexmodelsv2#ListSlotTypesRequest": { + "com.amazonaws.lexmodelsv2#SkipResourceInUseCheck": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.lexmodelsv2#SlotCaptureSetting": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the bot that contains the slot\n types.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "captureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "captureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot type.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the next step that the bot runs when the slot value is\n captured before the code hook times out.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "captureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the slot types to list.\n The string must match one of the supported locales. For more\n information, see Supported languages.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A list of conditional branches to evaluate after the slot value is\n captured.
" } }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSortBy", + "failureResponse": { + "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + }, + "failureNextStep": { + "target": "com.amazonaws.lexmodelsv2#DialogState", "traits": { - "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlotTypes operation. You can choose to sort by the\n slot type name or last updated date in either ascending or descending\n order.
Specifies the next step that the bot runs when the slot value code\n is not recognized.
" } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeFilters", + "failureConditional": { + "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", "traits": { - "smithy.api#documentation": "Provides the specification of a filter used to limit the slot types\n in the response to only those that match the filter specification. You\n can only specify one filter and only one string to filter on.
" + "smithy.api#documentation": "A list of conditional branches to evaluate when the slot value isn't\n captured.
" } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "codeHook": { + "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", "traits": { - "smithy.api#documentation": "The maximum number of slot types to return in each page of results.\n If there are fewer results than the max page size, only the actual\n number of results are returned.
" + "smithy.api#documentation": "Code hook called after Amazon Lex successfully captures a\n slot value.
" } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "elicitationCodeHook": { + "target": "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting", "traits": { - "smithy.api#documentation": "If the response from the ListSlotTypes operation\n contains more results than specified in the maxResults\n parameter, a token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
Code hook called when Amazon Lex doesn't capture a slot\n value.
" } } + }, + "traits": { + "smithy.api#documentation": "Settings used when Amazon Lex successfully captures a slot\n value from a user.
" } }, - "com.amazonaws.lexmodelsv2#ListSlotTypesResponse": { - "type": "structure", + "com.amazonaws.lexmodelsv2#SlotConstraint": { + "type": "enum", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the slot types.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot types.
" - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "Required": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The language and local of the slot types in the list.
" + "smithy.api#enumValue": "Required" } }, - "slotTypeSummaries": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSummaryList", + "Optional": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Summary information for the slot types that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n slot types available, the nextToken field contains a token\n to get the next page of results.
A token that indicates whether there are more results to return in a\n response to the ListSlotTypes operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListSlotTypes\n operation request to get the next page of results.
The default value to use when a user doesn't provide a value for a\n slot.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Specifies the default value to use when a user doesn't provide a\n value for a slot.
" } }, - "com.amazonaws.lexmodelsv2#ListSlots": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#ListSlotsRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#ListSlotsResponse" + "com.amazonaws.lexmodelsv2#SlotDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotDefaultValue" }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], "traits": { - "smithy.api#documentation": "Gets a list of slots that match the specified criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/{intentId}/slots", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" + "smithy.api#length": { + "min": 0, + "max": 10 } } }, - "com.amazonaws.lexmodelsv2#ListSlotsRequest": { + "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the slot.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", - "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the slots to list. The\n string must match one of the supported locales. For more information,\n see Supported languages.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "intentId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "defaultValueList": { + "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueList", "traits": { - "smithy.api#documentation": "The unique identifier of the intent that contains the slot.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "A list of default values. Amazon Lex chooses the default value to use in\n the order that they are presented in the list.
", "smithy.api#required": {} } - }, - "sortBy": { - "target": "com.amazonaws.lexmodelsv2#SlotSortBy", - "traits": { - "smithy.api#documentation": "Determines the sort order for the response from the\n ListSlots operation. You can choose to sort by the slot\n name or last updated date in either ascending or descending\n order.
Provides the specification of a filter used to limit the slots in\n the response to only those that match the filter specification. You can\n only specify one filter and only one string to filter on.
" - } - }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of slots to return in each page of results. If\n there are fewer results than the max page size, only the actual number\n of results are returned.
" - } - }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", - "traits": { - "smithy.api#documentation": "If the response from the ListSlots operation contains\n more results than specified in the maxResults parameter, a\n token is returned in the response. Use that token in the\n nextToken parameter to return the next page of\n results.
Defines a list of values that Amazon Lex should use as the default value\n for a slot.
" + } + }, + "com.amazonaws.lexmodelsv2#SlotDefaultValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 202 } } }, - "com.amazonaws.lexmodelsv2#ListSlotsResponse": { + "com.amazonaws.lexmodelsv2#SlotFilter": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the slots.
" - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot that contains the slots.
" - } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", - "traits": { - "smithy.api#documentation": "The language and locale of the slots in the list.
" - } - }, - "intentId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "name": { + "target": "com.amazonaws.lexmodelsv2#SlotFilterName", "traits": { - "smithy.api#documentation": "The identifier of the intent that contains the slots.
" + "smithy.api#documentation": "The name of the field to use for filtering.
", + "smithy.api#required": {} } }, - "slotSummaries": { - "target": "com.amazonaws.lexmodelsv2#SlotSummaryList", + "values": { + "target": "com.amazonaws.lexmodelsv2#FilterValues", "traits": { - "smithy.api#documentation": "Summary information for the slots that meet the filter criteria\n specified in the request. The length of the list is specified in the\n maxResults parameter of the request. If there are more\n slots available, the nextToken field contains a token to\n get the next page of results.
The value to use to filter the response.
", + "smithy.api#required": {} } }, - "nextToken": { - "target": "com.amazonaws.lexmodelsv2#NextToken", + "operator": { + "target": "com.amazonaws.lexmodelsv2#SlotFilterOperator", "traits": { - "smithy.api#documentation": "A token that indicates whether there are more results to return in a\n response to the ListSlots operation. If the\n nextToken field is present, you send the contents as\n the nextToken parameter of a ListSlots\n operation request to get the next page of results.
The operator to use for the filter. Specify EQ when the\n ListSlots operation should return only aliases that\n equal the specified value. Specify CO when the\n ListSlots operation should return aliases that contain\n the specified value.
Gets a list of tags associated with a resource. Only bots, bot\n aliases, and bot channels can have tags associated with them.
", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceARN}", - "code": 200 - } + "traits": { + "smithy.api#documentation": "Filters the response from the ListSlots\n operation.
The Amazon Resource Name (ARN) of the resource to get a list of tags\n for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "SlotName" } } } }, - "com.amazonaws.lexmodelsv2#ListTagsForResourceResponse": { - "type": "structure", + "com.amazonaws.lexmodelsv2#SlotFilterOperator": { + "type": "enum", "members": { - "tags": { - "target": "com.amazonaws.lexmodelsv2#TagMap", + "Contains": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The tags associated with a resource.
" + "smithy.api#enumValue": "CO" + } + }, + "Equals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQ" } } } }, - "com.amazonaws.lexmodelsv2#LocaleId": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#LocaleName": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#LogPrefix": { - "type": "string", + "com.amazonaws.lexmodelsv2#SlotFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotFilter" + }, "traits": { "smithy.api#length": { - "min": 0, - "max": 1024 + "min": 1, + "max": 1 } } }, - "com.amazonaws.lexmodelsv2#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } + "com.amazonaws.lexmodelsv2#SlotHintsIntentMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#Name" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#SlotHintsSlotMap" } }, - "com.amazonaws.lexmodelsv2#MaxUtteranceDigits": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1024 - } + "com.amazonaws.lexmodelsv2#SlotHintsSlotMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#Name" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#RuntimeHintDetails" } }, - "com.amazonaws.lexmodelsv2#MergeStrategy": { - "type": "enum", + "com.amazonaws.lexmodelsv2#SlotPrioritiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotPriority" + } + }, + "com.amazonaws.lexmodelsv2#SlotPriority": { + "type": "structure", "members": { - "Overwrite": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Overwrite" - } - }, - "FailOnConflict": { - "target": "smithy.api#Unit", + "priority": { + "target": "com.amazonaws.lexmodelsv2#PriorityValue", "traits": { - "smithy.api#enumValue": "FailOnConflict" + "smithy.api#documentation": "The priority that Amazon Lex should apply to the slot.
", + "smithy.api#required": {} } }, - "Append": { - "target": "smithy.api#Unit", + "slotId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#enumValue": "Append" + "smithy.api#documentation": "The unique identifier of the slot.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Sets the priority that Amazon Lex should use when eliciting slot values\n from a user.
" } }, - "com.amazonaws.lexmodelsv2#Message": { + "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItem": { "type": "structure", "members": { - "plainTextMessage": { - "target": "com.amazonaws.lexmodelsv2#PlainTextMessage", - "traits": { - "smithy.api#documentation": "A message in plain text format.
" - } - }, - "customPayload": { - "target": "com.amazonaws.lexmodelsv2#CustomPayload", - "traits": { - "smithy.api#documentation": "A message in a custom format defined by the client\n application.
" - } - }, - "ssmlMessage": { - "target": "com.amazonaws.lexmodelsv2#SSMLMessage", + "slotName": { + "target": "com.amazonaws.lexmodelsv2#TestResultSlotName", "traits": { - "smithy.api#documentation": "A message in Speech Synthesis Markup Language (SSML).
" + "smithy.api#documentation": "The name of the slot.
", + "smithy.api#required": {} } }, - "imageResponseCard": { - "target": "com.amazonaws.lexmodelsv2#ImageResponseCard", + "resultCounts": { + "target": "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItemCounts", "traits": { - "smithy.api#documentation": "A message that defines a response card that the client application\n can show to the user.
" + "smithy.api#documentation": "A result for slot resolution in the results of a test execution.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The object that provides message text and it's type.
" + "smithy.api#documentation": "Information about the success and failure rate of slot resolution \n in the results of a test execution.
" } }, - "com.amazonaws.lexmodelsv2#MessageGroup": { + "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItemCounts": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lexmodelsv2#Message", + "totalResultCount": { + "target": "com.amazonaws.lexmodelsv2#Count", "traits": { - "smithy.api#documentation": "The primary message that Amazon Lex should send to the user.
", + "smithy.api#documentation": "The total number of results.
", "smithy.api#required": {} } }, - "variations": { - "target": "com.amazonaws.lexmodelsv2#MessageVariationsList", + "speechTranscriptionResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", "traits": { - "smithy.api#documentation": "Message variations to send to the user. When variations are defined,\n Amazon Lex chooses the primary message or one of the variations to send to\n the user.
" + "smithy.api#documentation": "The number of matched, mismatched and execution error results for speech transcription for the slot.
" + } + }, + "slotMatchResultCounts": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap", + "traits": { + "smithy.api#documentation": "The number of matched and mismatched results for slot resolution for the slot.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Provides one or more messages that Amazon Lex should send to the\n user.
" + "smithy.api#documentation": "Information about the counts for a slot resolution in the results of a test execution.
" } }, - "com.amazonaws.lexmodelsv2#MessageGroupsList": { + "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItems": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#MessageGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } + "target": "com.amazonaws.lexmodelsv2#SlotResolutionTestResultItem" } }, - "com.amazonaws.lexmodelsv2#MessageSelectionStrategy": { + "com.amazonaws.lexmodelsv2#SlotShape": { "type": "enum", "members": { - "Random": { + "Scalar": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Random" + "smithy.api#enumValue": "Scalar" } }, - "Ordered": { + "List": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Ordered" + "smithy.api#enumValue": "List" } } } }, - "com.amazonaws.lexmodelsv2#MessageVariationsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#Message" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 + "com.amazonaws.lexmodelsv2#SlotSortAttribute": { + "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#MissedCount": { - "type": "integer" - }, - "com.amazonaws.lexmodelsv2#MultipleValuesSetting": { + "com.amazonaws.lexmodelsv2#SlotSortBy": { "type": "structure", "members": { - "allowMultipleValues": { - "target": "com.amazonaws.lexmodelsv2#Boolean", + "attribute": { + "target": "com.amazonaws.lexmodelsv2#SlotSortAttribute", "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 attribute to use to sort the list.
", + "smithy.api#required": {} + } + }, + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", + "traits": { + "smithy.api#documentation": "The order to sort the list. You can choose ascending or\n descending.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Indicates whether a slot can return multiple values.
" - } - }, - "com.amazonaws.lexmodelsv2#Name": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" + "smithy.api#documentation": "Specifies attributes for sorting a list of bots.
" } }, - "com.amazonaws.lexmodelsv2#NewCustomVocabularyItem": { + "com.amazonaws.lexmodelsv2#SlotSummary": { "type": "structure", "members": { - "phrase": { - "target": "com.amazonaws.lexmodelsv2#Phrase", + "slotId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique phrase for the new custom vocabulary item from the custom \n vocabulary list.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the slot.
" } }, - "weight": { - "target": "com.amazonaws.lexmodelsv2#Weight", + "slotName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The weight assigned to the new custom vocabulary item from the custom \n vocabulary list.
" + "smithy.api#documentation": "The name given to the slot.
" } }, - "displayAs": { - "target": "com.amazonaws.lexmodelsv2#Phrase", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The display as value assigned to the new custom vocabulary item from the custom \n vocabulary list.
" + "smithy.api#documentation": "The description of the slot.
" + } + }, + "slotConstraint": { + "target": "com.amazonaws.lexmodelsv2#SlotConstraint", + "traits": { + "smithy.api#documentation": "Whether the slot is required or optional. An intent is complete when\n all required slots are filled.
" + } + }, + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", + "traits": { + "smithy.api#documentation": "The unique identifier for the slot type that defines the values for\n the slot.
" + } + }, + "valueElicitationPromptSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptSpecification", + "traits": { + "smithy.api#documentation": "Prompts that are sent to the user to elicit a value for the\n slot.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the last date and time that the slot was\n updated.
" } } }, "traits": { - "smithy.api#documentation": "The new custom vocabulary item from the custom \n vocabulary list.
" - } - }, - "com.amazonaws.lexmodelsv2#NextIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 10000000 - } - } - }, - "com.amazonaws.lexmodelsv2#NextToken": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - } + "smithy.api#documentation": "Summary information about a slot, a value that the bot elicits from\n the user.
" } }, - "com.amazonaws.lexmodelsv2#NumericalBotVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^[0-9]+$" + "com.amazonaws.lexmodelsv2#SlotSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotSummary" } }, - "com.amazonaws.lexmodelsv2#ObfuscationSetting": { - "type": "structure", + "com.amazonaws.lexmodelsv2#SlotTypeCategory": { + "type": "enum", "members": { - "obfuscationSettingType": { - "target": "com.amazonaws.lexmodelsv2#ObfuscationSettingType", + "Custom": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Value that determines whether Amazon Lex obscures slot values in\n conversation logs. The default is to obscure the values.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Custom" } - } - }, - "traits": { - "smithy.api#documentation": "Determines whether Amazon Lex obscures slot values in conversation logs.\n
" - } - }, - "com.amazonaws.lexmodelsv2#ObfuscationSettingType": { - "type": "enum", - "members": { - "None": { + }, + "Extended": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "None" + "smithy.api#enumValue": "Extended" } }, - "DefaultObfuscation": { + "ExternalGrammar": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DefaultObfuscation" + "smithy.api#enumValue": "ExternalGrammar" } - } - } - }, - "com.amazonaws.lexmodelsv2#ObjectPrefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 }, - "smithy.api#pattern": "^[\\/]?+[a-zA-Z0-9!_.*'()-]+(\\/[a-zA-Z0-9!_.*'()-]+)*$" - } - }, - "com.amazonaws.lexmodelsv2#ObjectPrefixes": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#ObjectPrefix" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 + "Composite": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Composite" + } } } }, - "com.amazonaws.lexmodelsv2#Operation": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 5, - "max": 50 - }, - "smithy.api#pattern": "^lex:[a-zA-Z*]+$" - } - }, - "com.amazonaws.lexmodelsv2#OperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#Operation" - } - }, - "com.amazonaws.lexmodelsv2#OutputContext": { + "com.amazonaws.lexmodelsv2#SlotTypeFilter": { "type": "structure", "members": { "name": { - "target": "com.amazonaws.lexmodelsv2#Name", + "target": "com.amazonaws.lexmodelsv2#SlotTypeFilterName", "traits": { - "smithy.api#documentation": "The name of the output context.
", + "smithy.api#documentation": "The name of the field to use for filtering.
", "smithy.api#required": {} } }, - "timeToLiveInSeconds": { - "target": "com.amazonaws.lexmodelsv2#ContextTimeToLiveInSeconds", + "values": { + "target": "com.amazonaws.lexmodelsv2#FilterValues", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that the output context should\n remain active. The time is figured from the first time the context is\n sent to the user.
", + "smithy.api#documentation": "The value to use to filter the response.
", "smithy.api#required": {} } }, - "turnsToLive": { - "target": "com.amazonaws.lexmodelsv2#ContextTurnsToLive", + "operator": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeFilterOperator", "traits": { - "smithy.api#documentation": "The number of conversation turns that the output context should\n remain active. The number of turns is counted from the first time that\n the context is sent to the user.
", + "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListSlotTypes operation should return only aliases that\n equal the specified value. Specify CO when the\n ListSlotTypes operation should return aliases that\n contain the specified value.
Describes a session context that is activated when an intent is\n fulfilled.
" - } - }, - "com.amazonaws.lexmodelsv2#OutputContextsList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#OutputContext" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } + "smithy.api#documentation": "Filters the response from the ListSlotTypes\n operation.
The identifier of the network of bots assigned by Amazon Lex.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SlotTypeName" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "ExternalSourceType": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the network of bots.
", - "smithy.api#required": {} + "smithy.api#enumValue": "ExternalSourceType" } } - }, - "traits": { - "smithy.api#documentation": "A network of bots.
" - } - }, - "com.amazonaws.lexmodelsv2#ParentBotNetworks": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#ParentBotNetwork" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } } }, - "com.amazonaws.lexmodelsv2#PathFormat": { - "type": "structure", + "com.amazonaws.lexmodelsv2#SlotTypeFilterOperator": { + "type": "enum", "members": { - "objectPrefixes": { - "target": "com.amazonaws.lexmodelsv2#ObjectPrefixes", + "Contains": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3\n bucket. Specify this list if you only want Lex to read the files under\n this set of sub-folders.
" + "smithy.api#enumValue": "CO" } - } - }, - "traits": { - "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" - } - }, - "com.amazonaws.lexmodelsv2#Phrase": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.lexmodelsv2#PlainTextMessage": { - "type": "structure", - "members": { - "value": { - "target": "com.amazonaws.lexmodelsv2#PlainTextMessageValue", + }, + "Equals": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The message to send to the user.
", - "smithy.api#required": {} + "smithy.api#enumValue": "EQ" } } - }, - "traits": { - "smithy.api#documentation": "Defines an ASCII text message to send to the user.
" } }, - "com.amazonaws.lexmodelsv2#PlainTextMessageValue": { - "type": "string", + "com.amazonaws.lexmodelsv2#SlotTypeFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeFilter" + }, "traits": { "smithy.api#length": { "min": 1, - "max": 1000 + "max": 1 } } }, - "com.amazonaws.lexmodelsv2#Policy": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2 - } - } + "com.amazonaws.lexmodelsv2#SlotTypeSignature": { + "type": "string" }, - "com.amazonaws.lexmodelsv2#PostDialogCodeHookInvocationSpecification": { - "type": "structure", + "com.amazonaws.lexmodelsv2#SlotTypeSortAttribute": { + "type": "enum", "members": { - "successResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "successNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", - "traits": { - "smithy.api#documentation": "Specifics the next step the bot runs after the dialog code hook\n finishes successfully.
" - } - }, - "successConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "SlotTypeName": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the dialog code\n hook finishes successfully.
" + "smithy.api#enumValue": "SlotTypeName" } }, - "failureResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "failureNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies the next step the bot runs after the dialog code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.
A list of conditional branches to evaluate after the dialog code\n hook throws an exception or returns with the State field\n of the Intent object set to Failed.
The attribute to use to sort the list of slot types.
", + "smithy.api#required": {} } }, - "timeoutResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "timeoutNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot runs when the code hook times\n out.
" + "smithy.api#documentation": "The order to sort the list. You can say ascending or\n descending.
", + "smithy.api#required": {} } - }, - "timeoutConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + } + }, + "traits": { + "smithy.api#documentation": "Specifies attributes for sorting a list of slot types.
" + } + }, + "com.amazonaws.lexmodelsv2#SlotTypeStatistics": { + "type": "structure", + "members": { + "discoveredSlotTypeCount": { + "target": "com.amazonaws.lexmodelsv2#Count", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate if the code hook times\n out.
" + "smithy.api#documentation": "The number of recommended slot types associated with the bot\n recommendation.
" } } }, "traits": { - "smithy.api#documentation": "Specifies next steps to run after the dialog code hook\n finishes.
" + "smithy.api#documentation": "The object that contains the statistical summary of the recommended\n slot type associated with the bot recommendation.
" } }, - "com.amazonaws.lexmodelsv2#PostFulfillmentStatusSpecification": { + "com.amazonaws.lexmodelsv2#SlotTypeSummary": { "type": "structure", "members": { - "successResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "failureResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "timeoutResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" - }, - "successNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "Specifies the next step in the conversation that Amazon Lex\n invokes when the fulfillment code hook completes successfully.
" + "smithy.api#documentation": "The unique identifier assigned to the slot type.
" } }, - "successConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "slotTypeName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the fulfillment\n code hook finishes successfully.
" + "smithy.api#documentation": "The name of the slot type.
" } }, - "failureNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "Specifies the next step the bot runs after the fulfillment code hook\n throws an exception or returns with the State field of the\n Intent object set to Failed.
The description of the slot type.
" } }, - "failureConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the fulfillment\n code hook throws an exception or returns with the State\n field of the Intent object set to\n Failed.
If the slot type is derived from a built-on slot type, the name of\n the parent slot type.
" } }, - "timeoutNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot runs when the fulfillment code\n hook times out.
" + "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" } }, - "timeoutConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "slotTypeCategory": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeCategory", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate if the fulfillment code\n hook times out.
" + "smithy.api#documentation": "Indicates the type of the slot type.
\n\n Custom - A slot type that you created using\n custom values. For more information, see Creating custom slot\n types.
\n Extended - A slot type created by extending the\n AMAZON.AlphaNumeric built-in slot type. For more information, see\n \n AMAZON.AlphaNumeric\n .
\n ExternalGrammar - A slot type using a custom\n GRXML grammar to define values. For more information, see Using a custom grammar slot type.
Provides a setting that determines whether the post-fulfillment\n response is sent to the user. For more information, see https://docs.aws.amazon.com/lexv2/latest/dg/streaming-progress.html#progress-complete\n
" + "smithy.api#documentation": "Provides summary information about a slot type.
" } }, - "com.amazonaws.lexmodelsv2#PreconditionFailedException": { + "com.amazonaws.lexmodelsv2#SlotTypeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSummary" + } + }, + "com.amazonaws.lexmodelsv2#SlotTypeValue": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lexmodelsv2#ExceptionMessage" + "sampleValue": { + "target": "com.amazonaws.lexmodelsv2#SampleValue", + "traits": { + "smithy.api#documentation": "The value of the slot type entry.
" + } + }, + "synonyms": { + "target": "com.amazonaws.lexmodelsv2#SynonymList", + "traits": { + "smithy.api#documentation": "Additional values related to the slot type entry.
" + } } }, "traits": { - "smithy.api#documentation": "Your request couldn't be completed because one or more request\n fields aren't valid. Check the fields in your request and try\n again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 412 + "smithy.api#documentation": "Each slot type can have a set of values. Each\n SlotTypeValue represents a value that the slot type can\n take.
The name of the AWS service that should allowed or denied access to\n an Amazon Lex action.
" - } - }, - "arn": { - "target": "com.amazonaws.lexmodelsv2#PrincipalArn", + "interpretedValue": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the principal.
" + "smithy.api#documentation": "The value that Amazon Lex determines for the slot. The\n actual value depends on the setting of the value selection strategy for\n the bot. You can choose to use the value entered by the user, or you\n can have Amazon Lex choose the first value in the\n resolvedValues list.
The IAM principal that you allowing or denying access to an Amazon Lex\n action. You must provide a service or an arn,\n but not both in the same statement. For more information, see AWS JSON policy elements: Principal .
The value to set in a slot.
" } }, - "com.amazonaws.lexmodelsv2#PromptAttempt": { - "type": "enum", + "com.amazonaws.lexmodelsv2#SlotValueElicitationSetting": { + "type": "structure", "members": { - "Initial": { - "target": "smithy.api#Unit", + "defaultValueSpecification": { + "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification", "traits": { - "smithy.api#enumValue": "Initial" + "smithy.api#documentation": "A list of default values for a slot. Default values are used when\n Amazon Lex hasn't determined a value for a slot. You can specify default\n values from context variables, session attributes, and defined\n values.
" } }, - "Retry1": { - "target": "smithy.api#Unit", + "slotConstraint": { + "target": "com.amazonaws.lexmodelsv2#SlotConstraint", "traits": { - "smithy.api#enumValue": "Retry1" + "smithy.api#documentation": "Specifies whether the slot is required or optional.
", + "smithy.api#required": {} } }, - "Retry2": { - "target": "smithy.api#Unit", + "promptSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptSpecification", "traits": { - "smithy.api#enumValue": "Retry2" + "smithy.api#documentation": "The prompt that Amazon Lex uses to elicit the slot value from the\n user.
" } }, - "Retry3": { - "target": "smithy.api#Unit", + "sampleUtterances": { + "target": "com.amazonaws.lexmodelsv2#SampleUtterancesList", "traits": { - "smithy.api#enumValue": "Retry3" + "smithy.api#documentation": "If you know a specific pattern that users might respond to an Amazon Lex\n request for a slot value, you can provide those utterances to improve\n accuracy. This is optional. In most cases, Amazon Lex is capable of\n understanding user utterances.
" } }, - "Retry4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Retry4" - } + "waitAndContinueSpecification": { + "target": "com.amazonaws.lexmodelsv2#WaitAndContinueSpecification" }, - "Retry5": { - "target": "smithy.api#Unit", + "slotCaptureSetting": { + "target": "com.amazonaws.lexmodelsv2#SlotCaptureSetting", "traits": { - "smithy.api#enumValue": "Retry5" + "smithy.api#documentation": "Specifies the settings that Amazon Lex uses when a slot\n value is successfully entered by a user.
" } } }, "traits": { - "smithy.api#documentation": "The attempt name of attempts of a prompt.
" + "smithy.api#documentation": "Specifies the elicitation setting details eliciting a slot.
" } }, - "com.amazonaws.lexmodelsv2#PromptAttemptSpecification": { + "com.amazonaws.lexmodelsv2#SlotValueOverride": { "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", + "shape": { + "target": "com.amazonaws.lexmodelsv2#SlotShape", "traits": { - "smithy.api#documentation": "Indicates the allowed input types of the prompt attempt.
", - "smithy.api#required": {} + "smithy.api#documentation": "When the shape value is List, it indicates that the\n values field contains a list of slot values. When the\n value is Scalar, it indicates that the value\n field contains a single value.
Specifies the settings on audio and DTMF input.
" + "smithy.api#documentation": "The current value of the slot.
" } }, - "textInputSpecification": { - "target": "com.amazonaws.lexmodelsv2#TextInputSpecification", + "values": { + "target": "com.amazonaws.lexmodelsv2#SlotValues", "traits": { - "smithy.api#documentation": "Specifies the settings on text input.
" + "smithy.api#documentation": "A list of one or more values that the user provided for the slot.\n For example, for a slot that elicits pizza toppings, the values\n might be \"pepperoni\" and \"pineapple.\"
" } } }, "traits": { - "smithy.api#documentation": "Specifies the settings on a prompt attempt.
" + "smithy.api#documentation": "The slot values that Amazon Lex uses when it sets slot\n values in a dialog step.
" } }, - "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap": { + "com.amazonaws.lexmodelsv2#SlotValueOverrideMap": { "type": "map", "key": { - "target": "com.amazonaws.lexmodelsv2#PromptAttempt" + "target": "com.amazonaws.lexmodelsv2#Name" }, "value": { - "target": "com.amazonaws.lexmodelsv2#PromptAttemptSpecification" - } - }, - "com.amazonaws.lexmodelsv2#PromptMaxRetries": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 5 - } + "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" } }, - "com.amazonaws.lexmodelsv2#PromptSpecification": { + "com.amazonaws.lexmodelsv2#SlotValueRegexFilter": { "type": "structure", - "members": { - "messageGroups": { - "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", - "traits": { - "smithy.api#documentation": "A collection of messages that Amazon Lex can send to the user. Amazon Lex\n chooses the actual message to send at runtime.
", - "smithy.api#required": {} - } - }, - "maxRetries": { - "target": "com.amazonaws.lexmodelsv2#PromptMaxRetries", + "members": { + "pattern": { + "target": "com.amazonaws.lexmodelsv2#RegexPattern", "traits": { - "smithy.api#documentation": "The maximum number of times the bot tries to elicit a response from\n the user using this prompt.
", + "smithy.api#documentation": "A regular expression used to validate the value of a slot.
\nUse a standard regular expression. Amazon Lex supports the following\n characters in the regular expression:
\nA-Z, a-z
\n0-9
\nUnicode characters (\"\\u
Represent Unicode characters with four digits, for example \"\\u0041\"\n or \"\\u005A\".
\nThe following regular expression operators are not supported:
\nInfinite repeaters: *, +, or {x,} with no upper bound.
\nWild card (.)
\nProvides a regular expression used to validate the value of a\n slot.
" + } + }, + "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy": { + "type": "enum", + "members": { + "OriginalValue": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates whether the user can interrupt a speech prompt from the\n bot.
" + "smithy.api#enumValue": "OriginalValue" } }, - "messageSelectionStrategy": { - "target": "com.amazonaws.lexmodelsv2#MessageSelectionStrategy", + "TopResolution": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Indicates how a message is selected from a message group among retries.
" + "smithy.api#enumValue": "TopResolution" } }, - "promptAttemptsSpecification": { - "target": "com.amazonaws.lexmodelsv2#PromptAttemptsSpecificationMap", + "Concatenation": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Specifies the advanced settings on each attempt of the prompt.
" + "smithy.api#enumValue": "Concatenation" } } - }, - "traits": { - "smithy.api#documentation": "Specifies a list of message groups that Amazon Lex sends to a user to\n elicit a response.
" - } - }, - "com.amazonaws.lexmodelsv2#QueryFilterString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5000 - } - } - }, - "com.amazonaws.lexmodelsv2#RecommendedAction": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#RecommendedActions": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#RecommendedAction" } }, - "com.amazonaws.lexmodelsv2#RecommendedIntentSummary": { + "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting": { "type": "structure", "members": { - "intentId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "resolutionStrategy": { + "target": "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy", "traits": { - "smithy.api#documentation": "The unique identifier of a recommended intent associated with the\n bot recommendation.
" + "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\n ORIGINAL_VALUE - Returns the value entered by the user, if the\n user value is similar to the slot value.
\n TOP_RESOLUTION - 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.
If you don't specify the valueSelectionStrategy, the \n default is ORIGINAL_VALUE.
The name of a recommended intent associated with the bot\n recommendation.
" + "smithy.api#documentation": "A regular expression used to validate the value of a slot.
" } }, - "sampleUtterancesCount": { - "target": "com.amazonaws.lexmodelsv2#SampleUtterancesCount", + "advancedRecognitionSetting": { + "target": "com.amazonaws.lexmodelsv2#AdvancedRecognitionSetting", "traits": { - "smithy.api#documentation": "The count of sample utterances of a recommended intent that is\n associated with a bot recommendation.
" + "smithy.api#documentation": "Provides settings that enable advanced recognition settings for slot\n values. You can use this to enable using slot values as a custom\n vocabulary for recognizing user utterances.
" } } }, "traits": { - "smithy.api#documentation": "An object that contains a summary of a recommended intent.
" + "smithy.api#documentation": "Contains settings used by Amazon Lex to select a slot value.
" } }, - "com.amazonaws.lexmodelsv2#RecommendedIntentSummaryList": { + "com.amazonaws.lexmodelsv2#SlotValues": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#RecommendedIntentSummary" + "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" } }, - "com.amazonaws.lexmodelsv2#RegexPattern": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 300 + "com.amazonaws.lexmodelsv2#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.lexmodelsv2#RelativeAggregationDuration": { + "com.amazonaws.lexmodelsv2#Specifications": { "type": "structure", "members": { - "timeDimension": { - "target": "com.amazonaws.lexmodelsv2#TimeDimension", + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", "traits": { - "smithy.api#documentation": "The type of time period that the timeValue field\n represents.
The unique identifier assigned to the slot type.
", "smithy.api#required": {} } }, - "timeValue": { - "target": "com.amazonaws.lexmodelsv2#TimeValue", + "valueElicitationSetting": { + "target": "com.amazonaws.lexmodelsv2#SubSlotValueElicitationSetting", "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
Specifies the elicitation setting details for constituent sub slots of a composite slot.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the time window that utterance statistics are returned\n for. The time window is always relative to the last time that the that\n utterances were aggregated. For example, if the\n ListAggregatedUtterances operation is called at 1600,\n the time window is set to 1 hour, and the last refresh time was 1530,\n only utterances made between 1430 and 1530 are returned.
You can choose the time window that statistics should be returned\n for.
\n\n Hours - You can request\n utterance statistics for 1, 3, 6, 12, or 24 hour time windows.\n Statistics are refreshed every half hour for 1 hour time windows,\n and hourly for the other time windows.
\n\n Days - You can request\n utterance statistics for 3 days. Statistics are refreshed every 6\n hours.
\n\n Weeks - You can see\n statistics for one or two weeks. Statistics are refreshed every\n 12 hours for one week time windows, and once per day for two week\n time windows.
\nSubslot specifications.
" } }, - "com.amazonaws.lexmodelsv2#ResourceCount": { - "type": "integer" - }, - "com.amazonaws.lexmodelsv2#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.lexmodelsv2#ExceptionMessage" - } + "com.amazonaws.lexmodelsv2#StartBotRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse" }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], "traits": { - "smithy.api#documentation": "You asked to describe a resource that doesn't exist. Check the\n resource that you are requesting and try again.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 + "smithy.api#documentation": "Use this to provide your transcript data, and to start the bot\n recommendation process.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", + "code": 202 + } } }, - "com.amazonaws.lexmodelsv2#ResponseSpecification": { + "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest": { "type": "structure", "members": { - "messageGroups": { - "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "A collection of responses that Amazon Lex can send to the user. Amazon Lex\n chooses the actual response to send at runtime.
", + "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "allowInterrupt": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "Indicates whether the user can interrupt a speech response from\n Amazon Lex.
" + "smithy.api#documentation": "The version of the bot containing the bot recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "traits": { + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
", + "smithy.api#required": {} + } + }, + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "traits": { + "smithy.api#documentation": "The object representing the passwords that will be used to encrypt\n the data related to the bot recommendation results, as well as the KMS\n key ARN used to encrypt the associated metadata.
" } } }, "traits": { - "smithy.api#documentation": "Specifies a list of message groups that Amazon Lex uses to respond the\n user input.
" - } - }, - "com.amazonaws.lexmodelsv2#RetryAfterSeconds": { - "type": "integer", - "traits": { - "smithy.api#default": 0 + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#RevisionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 + "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
" + } }, - "smithy.api#pattern": "^[0-9]+$" - } - }, - "com.amazonaws.lexmodelsv2#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 32, - "max": 2048 + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot containing the bot recommendation.
" + } }, - "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/.*$" - } - }, - "com.amazonaws.lexmodelsv2#S3BucketArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + } + }, + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "traits": { + "smithy.api#documentation": "The status of the bot recommendation.
\nIf the status is Failed, then the reasons for the failure are listed\n in the failureReasons field.
" + } + }, + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot recommendation that you have\n created.
" + } }, - "smithy.api#pattern": "^arn:[\\w\\-]+:s3:::[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" - } - }, - "com.amazonaws.lexmodelsv2#S3BucketLogDestination": { - "type": "structure", - "members": { - "kmsKeyArn": { - "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AWS Key Management Service\n (KMS) key for encrypting audio log files stored in an S3 bucket.
" + "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n created.
" } }, - "s3BucketArn": { - "target": "com.amazonaws.lexmodelsv2#S3BucketArn", + "transcriptSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio\n log files are stored.
", - "smithy.api#required": {} + "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" } }, - "logPrefix": { - "target": "com.amazonaws.lexmodelsv2#LogPrefix", + "encryptionSetting": { + "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", "traits": { - "smithy.api#documentation": "The S3 prefix to assign to audio log files.
", - "smithy.api#required": {} + "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" } } }, "traits": { - "smithy.api#documentation": "Specifies an Amazon S3 bucket for logging audio conversations
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 + "com.amazonaws.lexmodelsv2#StartImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#StartImportRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#StartImportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" }, - "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts importing a bot, bot locale, or custom vocabulary from a zip\n archive that you uploaded to an S3 bucket.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/imports", + "code": 202 + } } }, - "com.amazonaws.lexmodelsv2#S3BucketTranscriptSource": { + "com.amazonaws.lexmodelsv2#StartImportRequest": { "type": "structure", "members": { - "s3BucketName": { - "target": "com.amazonaws.lexmodelsv2#S3BucketName", + "importId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The name of the bucket containing the transcript and the associated\n metadata.
", + "smithy.api#documentation": "The unique identifier for the import. It is included in the response\n from the CreateUploadUrl operation.
", "smithy.api#required": {} } }, - "pathFormat": { - "target": "com.amazonaws.lexmodelsv2#PathFormat", - "traits": { - "smithy.api#documentation": "The object that contains a path format that will be applied when\n Amazon Lex reads the transcript file in the bucket you provide. Specify this\n object if you only want Lex to read a subset of files in your Amazon S3\n bucket.
" - } - }, - "transcriptFormat": { - "target": "com.amazonaws.lexmodelsv2#TranscriptFormat", + "resourceSpecification": { + "target": "com.amazonaws.lexmodelsv2#ImportResourceSpecification", "traits": { - "smithy.api#documentation": "The format of the transcript content. Currently, Genie only supports\n the Amazon Lex transcript format.
", + "smithy.api#documentation": "Parameters for creating the bot, bot locale or custom\n vocabulary.
", "smithy.api#required": {} } }, - "transcriptFilter": { - "target": "com.amazonaws.lexmodelsv2#TranscriptFilter", + "mergeStrategy": { + "target": "com.amazonaws.lexmodelsv2#MergeStrategy", "traits": { - "smithy.api#documentation": "The object that contains the filter which will be applied when Amazon Lex\n reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to\n read only a subset of the Amazon S3 bucket based on the filter you\n provide.
" + "smithy.api#documentation": "The strategy to use when there is a name conflict between the\n imported resource and an existing resource. When the merge strategy is\n FailOnConflict existing resources are not overwritten\n and the import fails.
The ARN of the KMS key that customer use to encrypt their Amazon S3\n bucket. Only use this field if your bucket is encrypted using a\n customer managed KMS key.
" + "smithy.api#documentation": "The password used to encrypt the zip archive that contains the\n resource definition. You should always encrypt the zip archive to\n protect it during transit between your site and Amazon Lex.
" } } }, "traits": { - "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" - } - }, - "com.amazonaws.lexmodelsv2#S3ObjectPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#SSMLMessage": { + "com.amazonaws.lexmodelsv2#StartImportResponse": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.lexmodelsv2#SSMLMessageValue", + "importId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The SSML text that defines the prompt.
", - "smithy.api#required": {} + "smithy.api#documentation": "A unique identifier for the import.
" + } + }, + "resourceSpecification": { + "target": "com.amazonaws.lexmodelsv2#ImportResourceSpecification", + "traits": { + "smithy.api#documentation": "The parameters used when importing the resource.
" + } + }, + "mergeStrategy": { + "target": "com.amazonaws.lexmodelsv2#MergeStrategy", + "traits": { + "smithy.api#documentation": "The strategy used when there was a name conflict between the\n imported resource and an existing resource. When the merge strategy is\n FailOnConflict existing resources are not overwritten\n and the import fails.
The current status of the import. When the status is\n Complete the bot, bot alias, or custom vocabulary is\n ready to use.
The date and time that the import request was created.
" } } }, "traits": { - "smithy.api#documentation": "Defines a Speech Synthesis Markup Language (SSML) prompt.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#SSMLMessageValue": { - "type": "string", + "com.amazonaws.lexmodelsv2#StartTestExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#StartTestExecutionRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#StartTestExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 + "smithy.api#documentation": "The action to start test set execution.
", + "smithy.api#http": { + "method": "POST", + "uri": "/testsets/{testSetId}/testexecutions", + "code": 202 } } }, - "com.amazonaws.lexmodelsv2#SampleUtterance": { + "com.amazonaws.lexmodelsv2#StartTestExecutionRequest": { "type": "structure", "members": { - "utterance": { - "target": "com.amazonaws.lexmodelsv2#Utterance", + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The sample utterance that Amazon Lex uses to build its machine-learning\n model to recognize intents.
", + "smithy.api#documentation": "The test set Id for the test set execution.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionTarget", + "traits": { + "smithy.api#documentation": "The target bot for the test set execution.
", + "smithy.api#required": {} + } + }, + "apiMode": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionApiMode", + "traits": { + "smithy.api#documentation": "Indicates whether we use streaming or non-streaming APIs for the test set \n execution. For streaming, StartConversation Runtime API is used. Whereas, for \n non-streaming, RecognizeUtterance and RecognizeText Amazon Lex \n Runtime API are used.
", "smithy.api#required": {} } + }, + "testExecutionModality": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionModality", + "traits": { + "smithy.api#documentation": "Indicates whether audio or text is used.
" + } } }, "traits": { - "smithy.api#documentation": "A sample utterance that invokes an intent or respond to a slot\n elicitation prompt.
" - } - }, - "com.amazonaws.lexmodelsv2#SampleUtterancesCount": { - "type": "integer" - }, - "com.amazonaws.lexmodelsv2#SampleUtterancesList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SampleUtterance" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#SampleValue": { + "com.amazonaws.lexmodelsv2#StartTestExecutionResponse": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.lexmodelsv2#Value", + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The value that can be used for a slot type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the test set execution.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The creation date and time for the test set execution.
" + } + }, + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The test set Id for the test set execution.
" + } + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionTarget", + "traits": { + "smithy.api#documentation": "The target bot for the test set execution.
" + } + }, + "apiMode": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionApiMode", + "traits": { + "smithy.api#documentation": "Indicates whether we use streaming or non-streaming APIs for the test set \n execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas \n for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.
" + } + }, + "testExecutionModality": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionModality", + "traits": { + "smithy.api#documentation": "Indicates whether audio or text is used.
" } } }, "traits": { - "smithy.api#documentation": "Defines one of the values for a slot type.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#SearchAssociatedTranscripts": { + "com.amazonaws.lexmodelsv2#StartTestSetGeneration": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest" + "target": "com.amazonaws.lexmodelsv2#StartTestSetGenerationRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsResponse" + "target": "com.amazonaws.lexmodelsv2#StartTestSetGenerationResponse" }, "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, { "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, @@ -12640,1604 +16195,1433 @@ } ], "traits": { - "smithy.api#documentation": "Search for associated transcripts that meet the specified\n criteria.
", - "smithy.api#http": { - "method": "POST", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/associatedtranscripts", - "code": 200 - } - } - }, - "com.amazonaws.lexmodelsv2#SearchAssociatedTranscriptsRequest": { - "type": "structure", - "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the bot associated with the transcripts\n that you are searching.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", - "traits": { - "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } + "smithy.api#documentation": "The action to start the generation of test set.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/testsetgenerations", + "code": 202 }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.lexmodelsv2#StartTestSetGenerationRequest": { + "type": "structure", + "members": { + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The test set name for the test set generation request.
", "smithy.api#required": {} } }, - "botRecommendationId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The test set description for the test set generation request.
" } }, - "searchOrder": { - "target": "com.amazonaws.lexmodelsv2#SearchOrder", + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", "traits": { - "smithy.api#documentation": "How SearchResults are ordered. Valid values are Ascending or\n Descending. The default is Descending.
" + "smithy.api#documentation": "The Amazon S3 storage location for the test set generation.
", + "smithy.api#required": {} } }, - "filters": { - "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptFilters", + "generationDataSource": { + "target": "com.amazonaws.lexmodelsv2#TestSetGenerationDataSource", "traits": { - "smithy.api#documentation": "A list of filter objects.
", + "smithy.api#documentation": "The data source for the test set generation.
", "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", "traits": { - "smithy.api#documentation": "The maximum number of bot recommendations to return in each page of\n results. If there are fewer results than the max page size, only the\n actual number of results are returned.
" + "smithy.api#documentation": "The roleARN used for any operation in the test set to access \n resources in the Amazon Web Services account.
", + "smithy.api#required": {} } }, - "nextIndex": { - "target": "com.amazonaws.lexmodelsv2#NextIndex", + "testSetTags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", "traits": { - "smithy.api#documentation": "If the response from the SearchAssociatedTranscriptsRequest\n operation contains more results than specified in the maxResults\n parameter, an index is returned in the response. Use that index in the\n nextIndex parameter to return the next page of results.
" + "smithy.api#documentation": "A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
The unique identifier of the bot associated with the transcripts\n that you are searching.
" + "smithy.api#documentation": "The unique identifier of the test set generation to describe.
" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#BotVersion", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The version of the bot containing the transcripts that you are\n searching.
" + "smithy.api#documentation": "The creation date and time for the test set generation.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "testSetGenerationStatus": { + "target": "com.amazonaws.lexmodelsv2#TestSetGenerationStatus", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the transcripts to\n search. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + "smithy.api#documentation": "The status for the test set generation.
" } }, - "botRecommendationId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The unique identifier of the bot recommendation associated with the\n transcripts to search.
" + "smithy.api#documentation": "The test set name used for the test set generation.
" } }, - "nextIndex": { - "target": "com.amazonaws.lexmodelsv2#NextIndex", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "A index that indicates whether there are more results to return in a\n response to the SearchAssociatedTranscripts operation. If the nextIndex\n field is present, you send the contents as the nextIndex parameter of a\n SearchAssociatedTranscriptsRequest operation to get the next page of\n results.
" + "smithy.api#documentation": "The description used for the test set generation.
" } }, - "associatedTranscripts": { - "target": "com.amazonaws.lexmodelsv2#AssociatedTranscriptList", + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", "traits": { - "smithy.api#documentation": "The object that contains the associated transcript that meet the\n criteria you specified.
" + "smithy.api#documentation": "The Amazon S3 storage location for the test set generation.
" } }, - "totalResults": { - "target": "com.amazonaws.lexmodelsv2#MaxResults", - "traits": { - "smithy.api#documentation": "The total number of transcripts returned by the search.
" - } - } - } - }, - "com.amazonaws.lexmodelsv2#SearchOrder": { - "type": "enum", - "members": { - "Ascending": { - "target": "smithy.api#Unit", + "generationDataSource": { + "target": "com.amazonaws.lexmodelsv2#TestSetGenerationDataSource", "traits": { - "smithy.api#enumValue": "Ascending" + "smithy.api#documentation": "The data source for the test set generation.
" } }, - "Descending": { - "target": "smithy.api#Unit", + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", "traits": { - "smithy.api#enumValue": "Descending" + "smithy.api#documentation": "The roleARN used for any operation in the test set to access resources \n in the Amazon Web Services account.
" } - } - } - }, - "com.amazonaws.lexmodelsv2#SentimentAnalysisSettings": { - "type": "structure", - "members": { - "detectSentiment": { - "target": "com.amazonaws.lexmodelsv2#Boolean", + }, + "testSetTags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", "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": {} + "smithy.api#documentation": "A list of tags that was used for the test set that is being generated.
" } } }, "traits": { - "smithy.api#documentation": "Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of\n user utterances.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#ServicePrincipal": { - "type": "string", + "com.amazonaws.lexmodelsv2#StillWaitingResponseFrequency": { + "type": "integer", "traits": { - "smithy.api#length": { - "min": 15, - "max": 1024 - }, - "smithy.api#pattern": "^[0-9a-zA-Z_.]+$" + "smithy.api#range": { + "min": 1, + "max": 300 + } } }, - "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException": { + "com.amazonaws.lexmodelsv2#StillWaitingResponseSpecification": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.lexmodelsv2#ExceptionMessage" + "messageGroups": { + "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", + "traits": { + "smithy.api#documentation": "One or more message groups, each containing one or more messages,\n that define the prompts that Amazon Lex sends to the user.
", + "smithy.api#required": {} + } + }, + "frequencyInSeconds": { + "target": "com.amazonaws.lexmodelsv2#StillWaitingResponseFrequency", + "traits": { + "smithy.api#documentation": "How often a message should be sent to the user. Minimum of 1 second,\n maximum of 5 minutes.
", + "smithy.api#required": {} + } + }, + "timeoutInSeconds": { + "target": "com.amazonaws.lexmodelsv2#StillWaitingResponseTimeout", + "traits": { + "smithy.api#documentation": "If Amazon Lex waits longer than this length of time for a response, it\n will stop sending messages.
", + "smithy.api#required": {} + } + }, + "allowInterrupt": { + "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", + "traits": { + "smithy.api#documentation": "Indicates that the user can interrupt the response by speaking while\n the message is being played.
" + } } }, "traits": { - "smithy.api#documentation": "You have reached a quota for your bot.
", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.lexmodelsv2#SessionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 100 - }, - "smithy.api#pattern": "^[0-9a-zA-Z._:-]+$" + "smithy.api#documentation": "Defines the messages that Amazon Lex sends to a user to remind them that\n the bot is waiting for a response.
" } }, - "com.amazonaws.lexmodelsv2#SessionTTL": { + "com.amazonaws.lexmodelsv2#StillWaitingResponseTimeout": { "type": "integer", "traits": { "smithy.api#range": { - "min": 60, - "max": 86400 + "min": 1, + "max": 900 } } }, - "com.amazonaws.lexmodelsv2#SkipResourceInUseCheck": { - "type": "boolean", + "com.amazonaws.lexmodelsv2#StopBotRecommendation": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#StopBotRecommendationRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#StopBotRecommendationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], "traits": { - "smithy.api#default": false + "smithy.api#documentation": "Stop an already running Bot Recommendation request.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation", + "code": 202 + } } }, - "com.amazonaws.lexmodelsv2#SlotCaptureSetting": { + "com.amazonaws.lexmodelsv2#StopBotRecommendationRequest": { "type": "structure", "members": { - "captureResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation to be stopped.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "captureNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot runs when the slot value is\n captured before the code hook times out.
" + "smithy.api#documentation": "The version of the bot containing the bot recommendation.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "captureConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate after the slot value is\n captured.
" + "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to stop. The string must match one of the supported locales. For more\n information, see Supported languages\n
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "failureResponse": { - "target": "com.amazonaws.lexmodelsv2#ResponseSpecification" + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot recommendation to be\n stopped.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#StopBotRecommendationResponse": { + "type": "structure", + "members": { + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the bot containing the bot recommendation that \n is being stopped.
" + } }, - "failureNextStep": { - "target": "com.amazonaws.lexmodelsv2#DialogState", + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "Specifies the next step that the bot runs when the slot value code\n is not recognized.
" + "smithy.api#documentation": "The version of the bot containing the recommendation that is being \n stopped.
" } }, - "failureConditional": { - "target": "com.amazonaws.lexmodelsv2#ConditionalSpecification", + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", "traits": { - "smithy.api#documentation": "A list of conditional branches to evaluate when the slot value isn't\n captured.
" + "smithy.api#documentation": "The identifier of the language and locale of the bot response\n to stop. The string must match one of the supported locales. For more\n information, see Supported languages\n
" } }, - "codeHook": { - "target": "com.amazonaws.lexmodelsv2#DialogCodeHookInvocationSetting", + "botRecommendationStatus": { + "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", "traits": { - "smithy.api#documentation": "Code hook called after Amazon Lex successfully captures a\n slot value.
" + "smithy.api#documentation": "The status of the bot recommendation. If the status is Failed, \n then the reasons for the failure are listed in the failureReasons field.
" } }, - "elicitationCodeHook": { - "target": "com.amazonaws.lexmodelsv2#ElicitationCodeHookInvocationSetting", + "botRecommendationId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "Code hook called when Amazon Lex doesn't capture a slot\n value.
" + "smithy.api#documentation": "The unique identifier of the bot recommendation that is being\n stopped.
" } } }, "traits": { - "smithy.api#documentation": "Settings used when Amazon Lex successfully captures a slot\n value from a user.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#SlotConstraint": { - "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#String": { + "type": "string" }, - "com.amazonaws.lexmodelsv2#SlotDefaultValue": { - "type": "structure", - "members": { - "defaultValue": { - "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueString", - "traits": { - "smithy.api#documentation": "The default value to use when a user doesn't provide a value for a\n slot.
", - "smithy.api#required": {} - } - } + "com.amazonaws.lexmodelsv2#StringMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString" }, - "traits": { - "smithy.api#documentation": "Specifies the default value to use when a user doesn't provide a\n value for a slot.
" + "value": { + "target": "com.amazonaws.lexmodelsv2#String" } }, - "com.amazonaws.lexmodelsv2#SlotDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SlotDefaultValue" - }, + "com.amazonaws.lexmodelsv2#SubSlotExpression": { + "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 10 - } + "max": 640 + }, + "smithy.api#pattern": "^[0-9A-Za-z_\\-\\s\\(\\)]+$" } }, - "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification": { + "com.amazonaws.lexmodelsv2#SubSlotSetting": { "type": "structure", "members": { - "defaultValueList": { - "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueList", + "expression": { + "target": "com.amazonaws.lexmodelsv2#SubSlotExpression", "traits": { - "smithy.api#documentation": "A list of default values. Amazon Lex chooses the default value to use in\n the order that they are presented in the list.
", - "smithy.api#required": {} + "smithy.api#documentation": "The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
" + } + }, + "slotSpecifications": { + "target": "com.amazonaws.lexmodelsv2#SubSlotSpecificationMap", + "traits": { + "smithy.api#documentation": "Specifications for the constituent sub slots of a composite slot.
" } } }, "traits": { - "smithy.api#documentation": "Defines a list of values that Amazon Lex should use as the default value\n for a slot.
" + "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" } }, - "com.amazonaws.lexmodelsv2#SlotDefaultValueString": { - "type": "string", + "com.amazonaws.lexmodelsv2#SubSlotSpecificationMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#Name" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#Specifications" + }, "traits": { "smithy.api#length": { - "min": 1, - "max": 202 + "min": 0, + "max": 6 } } }, - "com.amazonaws.lexmodelsv2#SlotFilter": { + "com.amazonaws.lexmodelsv2#SubSlotTypeComposition": { "type": "structure", "members": { "name": { - "target": "com.amazonaws.lexmodelsv2#SlotFilterName", - "traits": { - "smithy.api#documentation": "The name of the field to use for filtering.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.lexmodelsv2#FilterValues", + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The value to use to filter the response.
", + "smithy.api#documentation": "Name of a constituent sub slot inside a composite slot.
", "smithy.api#required": {} } }, - "operator": { - "target": "com.amazonaws.lexmodelsv2#SlotFilterOperator", + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", "traits": { - "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListSlots operation should return only aliases that\n equal the specified value. Specify CO when the\n ListSlots operation should return aliases that contain\n the specified value.
The unique identifier assigned to a slot type. \n This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Filters the response from the ListSlots\n operation.
Subslot type composition.
" } }, - "com.amazonaws.lexmodelsv2#SlotFilterName": { - "type": "enum", - "members": { - "SlotName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SlotName" - } + "com.amazonaws.lexmodelsv2#SubSlotTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#SubSlotTypeComposition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 6 } } }, - "com.amazonaws.lexmodelsv2#SlotFilterOperator": { - "type": "enum", + "com.amazonaws.lexmodelsv2#SubSlotValueElicitationSetting": { + "type": "structure", "members": { - "Contains": { - "target": "smithy.api#Unit", + "defaultValueSpecification": { + "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification" + }, + "promptSpecification": { + "target": "com.amazonaws.lexmodelsv2#PromptSpecification", "traits": { - "smithy.api#enumValue": "CO" + "smithy.api#required": {} } }, - "Equals": { - "target": "smithy.api#Unit", + "sampleUtterances": { + "target": "com.amazonaws.lexmodelsv2#SampleUtterancesList", "traits": { - "smithy.api#enumValue": "EQ" + "smithy.api#documentation": "If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, \n you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable \n of understanding user utterances. This is similar to SampleUtterances for slots.
Subslot elicitation settings.
\n\n DefaultValueSpecification is a list of default values for a constituent sub slot in a composite slot. Default values are used when \n Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, \n session attributes, and defined values. This is similar to DefaultValueSpecification for slots.
\n PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. \n This is similar to PromptSpecification for slots.
The priority that a slot should be elicited.
", - "smithy.api#required": {} - } - }, - "slotId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the slot.
", - "smithy.api#required": {} - } - } + "com.amazonaws.lexmodelsv2#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#TagKey" }, "traits": { - "smithy.api#documentation": "Sets the priority that Amazon Lex should use when eliciting slot values\n from a user.
" + "smithy.api#length": { + "min": 0, + "max": 200 + } } }, - "com.amazonaws.lexmodelsv2#SlotShape": { - "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#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#TagKey" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 } } }, - "com.amazonaws.lexmodelsv2#SlotSortAttribute": { - "type": "enum", - "members": { - "SlotName": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SlotName" - } + "com.amazonaws.lexmodelsv2#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" }, - "LastUpdatedDateTime": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LastUpdatedDateTime" - } + { + "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds the specified tags to the specified resource. If a tag key\n already exists, the existing value is replaced with the new\n value.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{resourceARN}", + "code": 200 } } }, - "com.amazonaws.lexmodelsv2#SlotSortBy": { + "com.amazonaws.lexmodelsv2#TagResourceRequest": { "type": "structure", "members": { - "attribute": { - "target": "com.amazonaws.lexmodelsv2#SlotSortAttribute", + "resourceARN": { + "target": "com.amazonaws.lexmodelsv2#AmazonResourceName", "traits": { - "smithy.api#documentation": "The attribute to use to sort the list.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel\n to tag.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "order": { - "target": "com.amazonaws.lexmodelsv2#SortOrder", + "tags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", "traits": { - "smithy.api#documentation": "The order to sort the list. You can choose ascending or\n descending.
", + "smithy.api#documentation": "A list of tag keys to add to the resource. If a tag key already\n exists, the existing value is replaced with the new value.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies attributes for sorting a list of bots.
" + "smithy.api#input": {} } }, - "com.amazonaws.lexmodelsv2#SlotSummary": { + "com.amazonaws.lexmodelsv2#TagResourceResponse": { "type": "structure", - "members": { - "slotId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier of the slot.
" - } - }, - "slotName": { - "target": "com.amazonaws.lexmodelsv2#Name", - "traits": { - "smithy.api#documentation": "The name given to the slot.
" - } - }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", - "traits": { - "smithy.api#documentation": "The description of the slot.
" - } - }, - "slotConstraint": { - "target": "com.amazonaws.lexmodelsv2#SlotConstraint", - "traits": { - "smithy.api#documentation": "Whether the slot is required or optional. An intent is complete when\n all required slots are filled.
" - } - }, - "slotTypeId": { - "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", - "traits": { - "smithy.api#documentation": "The unique identifier for the slot type that defines the values for\n the slot.
" - } - }, - "valueElicitationPromptSpecification": { - "target": "com.amazonaws.lexmodelsv2#PromptSpecification", - "traits": { - "smithy.api#documentation": "Prompts that are sent to the user to elicit a value for the\n slot.
" - } - }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp of the last date and time that the slot was\n updated.
" - } - } - }, + "members": {}, "traits": { - "smithy.api#documentation": "Summary information about a slot, a value that the bot elicits from\n the user.
" + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#SlotSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SlotSummary" + "com.amazonaws.lexmodelsv2#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } } }, - "com.amazonaws.lexmodelsv2#SlotTypeCategory": { + "com.amazonaws.lexmodelsv2#TestExecutionApiMode": { "type": "enum", "members": { - "Custom": { + "Streaming": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Custom" + "smithy.api#enumValue": "Streaming" } }, - "Extended": { + "NonStreaming": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Extended" + "smithy.api#enumValue": "NonStreaming" } - }, - "ExternalGrammar": { + } + } + }, + "com.amazonaws.lexmodelsv2#TestExecutionModality": { + "type": "enum", + "members": { + "Text": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ExternalGrammar" + "smithy.api#enumValue": "Text" } }, - "Composite": { + "Audio": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Composite" + "smithy.api#enumValue": "Audio" } } } }, - "com.amazonaws.lexmodelsv2#SlotTypeFilter": { + "com.amazonaws.lexmodelsv2#TestExecutionResultFilterBy": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeFilterName", - "traits": { - "smithy.api#documentation": "The name of the field to use for filtering.
", - "smithy.api#required": {} - } - }, - "values": { - "target": "com.amazonaws.lexmodelsv2#FilterValues", + "resultTypeFilter": { + "target": "com.amazonaws.lexmodelsv2#TestResultTypeFilter", "traits": { - "smithy.api#documentation": "The value to use to filter the response.
", + "smithy.api#documentation": "Specifies which results to filter. See Test result details\">Test results details \n for details about different types of results.
", "smithy.api#required": {} } }, - "operator": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeFilterOperator", + "conversationLevelTestResultsFilterBy": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelTestResultsFilterBy", "traits": { - "smithy.api#documentation": "The operator to use for the filter. Specify EQ when the\n ListSlotTypes operation should return only aliases that\n equal the specified value. Specify CO when the\n ListSlotTypes operation should return aliases that\n contain the specified value.
Contains information about the method for filtering Conversation level test results.
" } } }, "traits": { - "smithy.api#documentation": "Filters the response from the ListSlotTypes\n operation.
Contains information about the method by which to filter the results of the test execution.
" } }, - "com.amazonaws.lexmodelsv2#SlotTypeFilterName": { - "type": "enum", + "com.amazonaws.lexmodelsv2#TestExecutionResultItems": { + "type": "structure", "members": { - "SlotTypeName": { - "target": "smithy.api#Unit", + "overallTestResults": { + "target": "com.amazonaws.lexmodelsv2#OverallTestResults", "traits": { - "smithy.api#enumValue": "SlotTypeName" + "smithy.api#documentation": "Overall results for the test execution, including the breakdown of conversations and \n single-input utterances.
" } }, - "ExternalSourceType": { - "target": "smithy.api#Unit", + "conversationLevelTestResults": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelTestResults", "traits": { - "smithy.api#enumValue": "ExternalSourceType" + "smithy.api#documentation": "Results related to conversations in the test set, including metrics about success and failure of\n conversations and intent and slot failures.
" } - } - } - }, - "com.amazonaws.lexmodelsv2#SlotTypeFilterOperator": { - "type": "enum", - "members": { - "Contains": { - "target": "smithy.api#Unit", + }, + "intentClassificationTestResults": { + "target": "com.amazonaws.lexmodelsv2#IntentClassificationTestResults", "traits": { - "smithy.api#enumValue": "CO" + "smithy.api#documentation": "Intent recognition results aggregated by intent name. The aggregated results contain success and failure rates of intent recognition,\n speech transcriptions, and end-to-end conversations.
" } }, - "Equals": { - "target": "smithy.api#Unit", + "intentLevelSlotResolutionTestResults": { + "target": "com.amazonaws.lexmodelsv2#IntentLevelSlotResolutionTestResults", "traits": { - "smithy.api#enumValue": "EQ" + "smithy.api#documentation": "Slot resolution results aggregated by intent and slot name. The aggregated results contain success and failure rates of slot resolution,\n speech transcriptions, and end-to-end conversations
" + } + }, + "utteranceLevelTestResults": { + "target": "com.amazonaws.lexmodelsv2#UtteranceLevelTestResults", + "traits": { + "smithy.api#documentation": "Results related to utterances in the test set.
" } } - } - }, - "com.amazonaws.lexmodelsv2#SlotTypeFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeFilter" }, "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } + "smithy.api#documentation": "Contains the results of the test execution, grouped by type of results.\n See Test result details\">Test results details \n for details about different types of results.
" } }, - "com.amazonaws.lexmodelsv2#SlotTypeSignature": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#SlotTypeSortAttribute": { + "com.amazonaws.lexmodelsv2#TestExecutionSortAttribute": { "type": "enum", "members": { - "SlotTypeName": { + "TestSetName": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SlotTypeName" + "smithy.api#enumValue": "TestSetName" } }, - "LastUpdatedDateTime": { + "CreationDateTime": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LastUpdatedDateTime" + "smithy.api#enumValue": "CreationDateTime" } } } }, - "com.amazonaws.lexmodelsv2#SlotTypeSortBy": { + "com.amazonaws.lexmodelsv2#TestExecutionSortBy": { "type": "structure", "members": { "attribute": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSortAttribute", + "target": "com.amazonaws.lexmodelsv2#TestExecutionSortAttribute", "traits": { - "smithy.api#documentation": "The attribute to use to sort the list of slot types.
", + "smithy.api#documentation": "Specifies whether to sort the test set executions by the date and time at which the test sets were created.
", "smithy.api#required": {} } }, "order": { "target": "com.amazonaws.lexmodelsv2#SortOrder", "traits": { - "smithy.api#documentation": "The order to sort the list. You can say ascending or\n descending.
", + "smithy.api#documentation": "Specifies whether to sort in ascending or descending order.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies attributes for sorting a list of slot types.
" - } - }, - "com.amazonaws.lexmodelsv2#SlotTypeStatistics": { - "type": "structure", - "members": { - "discoveredSlotTypeCount": { - "target": "com.amazonaws.lexmodelsv2#Count", - "traits": { - "smithy.api#documentation": "The number of recommended slot types associated with the bot\n recommendation.
" - } - } - }, - "traits": { - "smithy.api#documentation": "The object that contains the statistical summary of the recommended\n slot type associated with the bot recommendation.
" + "smithy.api#documentation": "Contains information about the method by which to sort the instances of \n test executions you have carried out.
" } }, - "com.amazonaws.lexmodelsv2#SlotTypeSummary": { - "type": "structure", + "com.amazonaws.lexmodelsv2#TestExecutionStatus": { + "type": "enum", "members": { - "slotTypeId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "Pending": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier assigned to the slot type.
" + "smithy.api#enumValue": "Pending" } }, - "slotTypeName": { - "target": "com.amazonaws.lexmodelsv2#Name", + "Waiting": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the slot type.
" + "smithy.api#enumValue": "Waiting" } }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", + "InProgress": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The description of the slot type.
" + "smithy.api#enumValue": "InProgress" } }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", + "Completed": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "If the slot type is derived from a built-on slot type, the name of\n the parent slot type.
" + "smithy.api#enumValue": "Completed" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", + "Failed": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" + "smithy.api#enumValue": "Failed" } }, - "slotTypeCategory": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeCategory", - "traits": { - "smithy.api#documentation": "Indicates the type of the slot type.
\n\n Custom - A slot type that you created using\n custom values. For more information, see Creating custom slot\n types.
\n Extended - A slot type created by extending the\n AMAZON.AlphaNumeric built-in slot type. For more information, see\n AMAZON.AlphaNumeric.
\n ExternalGrammar - A slot type using a custom\n GRXML grammar to define values. For more information, see Using a custom grammar slot type.
Provides summary information about a slot type.
" - } - }, - "com.amazonaws.lexmodelsv2#SlotTypeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSummary" - } - }, - "com.amazonaws.lexmodelsv2#SlotTypeValue": { - "type": "structure", - "members": { - "sampleValue": { - "target": "com.amazonaws.lexmodelsv2#SampleValue", + "Stopping": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The value of the slot type entry.
" + "smithy.api#enumValue": "Stopping" } }, - "synonyms": { - "target": "com.amazonaws.lexmodelsv2#SynonymList", - "traits": { - "smithy.api#documentation": "Additional values related to the slot type entry.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Each slot type can have a set of values. Each\n SlotTypeValue represents a value that the slot type can\n take.
The value that Amazon Lex determines for the slot. The\n actual value depends on the setting of the value selection strategy for\n the bot. You can choose to use the value entered by the user, or you\n can have Amazon Lex choose the first value in the\n resolvedValues list.
The value to set in a slot.
" } }, - "com.amazonaws.lexmodelsv2#SlotValueElicitationSetting": { + "com.amazonaws.lexmodelsv2#TestExecutionSummary": { "type": "structure", "members": { - "defaultValueSpecification": { - "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification", + "testExecutionId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "A list of default values for a slot. Default values are used when\n Amazon Lex hasn't determined a value for a slot. You can specify default\n values from context variables, session attributes, and defined\n values.
" + "smithy.api#documentation": "The unique identifier of the test execution.
" } }, - "slotConstraint": { - "target": "com.amazonaws.lexmodelsv2#SlotConstraint", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "Specifies whether the slot is required or optional.
", - "smithy.api#required": {} + "smithy.api#documentation": "The date and time at which the test execution was created.
" } }, - "promptSpecification": { - "target": "com.amazonaws.lexmodelsv2#PromptSpecification", + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "The prompt that Amazon Lex uses to elicit the slot value from the\n user.
" + "smithy.api#documentation": "The date and time at which the test execution was last updated.
" } }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelsv2#SampleUtterancesList", + "testExecutionStatus": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionStatus", "traits": { - "smithy.api#documentation": "If you know a specific pattern that users might respond to an Amazon Lex\n request for a slot value, you can provide those utterances to improve\n accuracy. This is optional. In most cases, Amazon Lex is capable of\n understanding user utterances.
" + "smithy.api#documentation": "The current status of the test execution.
" } }, - "waitAndContinueSpecification": { - "target": "com.amazonaws.lexmodelsv2#WaitAndContinueSpecification" + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the test set used in the test execution.
" + } }, - "slotCaptureSetting": { - "target": "com.amazonaws.lexmodelsv2#SlotCaptureSetting", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "Specifies the settings that Amazon Lex uses when a slot\n value is successfully entered by a user.
" + "smithy.api#documentation": "The name of the test set used in the test execution.
" } - } - }, - "traits": { - "smithy.api#documentation": "Specifies the elicitation setting details for constituent sub slots of a composite slot.
" - } - }, - "com.amazonaws.lexmodelsv2#SlotValueOverride": { - "type": "structure", - "members": { - "shape": { - "target": "com.amazonaws.lexmodelsv2#SlotShape", + }, + "target": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionTarget", "traits": { - "smithy.api#documentation": "When the shape value is List, it indicates that the\n values field contains a list of slot values. When the\n value is Scalar, it indicates that the value\n field contains a single value.
Contains information about the bot used for the test execution..
" } }, - "value": { - "target": "com.amazonaws.lexmodelsv2#SlotValue", + "apiMode": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionApiMode", "traits": { - "smithy.api#documentation": "The current value of the slot.
" + "smithy.api#documentation": "Specifies whether the API mode for the test execution is streaming \n or non-streaming.
" } }, - "values": { - "target": "com.amazonaws.lexmodelsv2#SlotValues", + "testExecutionModality": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionModality", "traits": { - "smithy.api#documentation": "A list of one or more values that the user provided for the slot.\n For example, for a slot that elicits pizza toppings, the values\n might be \"pepperoni\" and \"pineapple.\"
" + "smithy.api#documentation": "Specifies whether the data used for the test execution is written\n or spoken.
" } } }, "traits": { - "smithy.api#documentation": "The slot values that Amazon Lex uses when it sets slot\n values in a dialog step.
" + "smithy.api#documentation": "Summarizes metadata about the test execution.
" } }, - "com.amazonaws.lexmodelsv2#SlotValueOverrideMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lexmodelsv2#Name" - }, - "value": { - "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" + "com.amazonaws.lexmodelsv2#TestExecutionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#TestExecutionSummary" } }, - "com.amazonaws.lexmodelsv2#SlotValueRegexFilter": { + "com.amazonaws.lexmodelsv2#TestExecutionTarget": { "type": "structure", "members": { - "pattern": { - "target": "com.amazonaws.lexmodelsv2#RegexPattern", + "botAliasTarget": { + "target": "com.amazonaws.lexmodelsv2#BotAliasTestExecutionTarget", "traits": { - "smithy.api#documentation": "A regular expression used to validate the value of a slot.
\nUse a standard regular expression. Amazon Lex supports the following\n characters in the regular expression:
\nA-Z, a-z
\n0-9
\nUnicode characters (\"\\ u
Represent Unicode characters with four digits, for example \"\\u0041\"\n or \"\\u005A\".
\nThe following regular expression operators are not supported:
\nInfinite repeaters: *, +, or {x,} with no upper bound.
\nWild card (.)
\nContains information about the bot alias used for the test execution.
" } } }, "traits": { - "smithy.api#documentation": "Provides a regular expression used to validate the value of a\n slot.
" + "smithy.api#documentation": "Contains information about the bot used for the test execution.
" } }, - "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy": { + "com.amazonaws.lexmodelsv2#TestResultMatchStatus": { "type": "enum", "members": { - "OriginalValue": { + "Matched": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "OriginalValue" + "smithy.api#enumValue": "Matched" } }, - "TopResolution": { + "Mismatched": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TopResolution" + "smithy.api#enumValue": "Mismatched" } }, - "Concatenation": { + "ExecutionError": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "Concatenation" + "smithy.api#enumValue": "ExecutionError" } } } }, - "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting": { - "type": "structure", + "com.amazonaws.lexmodelsv2#TestResultMatchStatusCountMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#Count" + } + }, + "com.amazonaws.lexmodelsv2#TestResultSlotName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_.-]?)+$" + } + }, + "com.amazonaws.lexmodelsv2#TestResultTypeFilter": { + "type": "enum", "members": { - "resolutionStrategy": { - "target": "com.amazonaws.lexmodelsv2#SlotValueResolutionStrategy", + "OverallTestResults": { + "target": "smithy.api#Unit", "traits": { - "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:
\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": {} + "smithy.api#enumValue": "OverallTestResults" } }, - "regexFilter": { - "target": "com.amazonaws.lexmodelsv2#SlotValueRegexFilter", + "ConversationLevelTestResults": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "A regular expression used to validate the value of a slot.
" + "smithy.api#enumValue": "ConversationLevelTestResults" } }, - "advancedRecognitionSetting": { - "target": "com.amazonaws.lexmodelsv2#AdvancedRecognitionSetting", + "IntentClassificationTestResults": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IntentClassificationTestResults" + } + }, + "SlotResolutionTestResults": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SlotResolutionTestResults" + } + }, + "UtteranceLevelResults": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "Provides settings that enable advanced recognition settings for slot\n values.
" + "smithy.api#enumValue": "UtteranceLevelResults" } } - }, + } + }, + "com.amazonaws.lexmodelsv2#TestSetAgentPrompt": { + "type": "string", "traits": { - "smithy.api#documentation": "Contains settings used by Amazon Lex to select a slot value.
" + "smithy.api#length": { + "min": 1, + "max": 1024 + } } }, - "com.amazonaws.lexmodelsv2#SlotValues": { - "type": "list", - "member": { - "target": "com.amazonaws.lexmodelsv2#SlotValueOverride" + "com.amazonaws.lexmodelsv2#TestSetConversationId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^([0-9a-zA-Z][_-]?)+$" } }, - "com.amazonaws.lexmodelsv2#SortOrder": { - "type": "enum", + "com.amazonaws.lexmodelsv2#TestSetDiscrepancyErrors": { + "type": "structure", "members": { - "Ascending": { - "target": "smithy.api#Unit", + "intentDiscrepancies": { + "target": "com.amazonaws.lexmodelsv2#TestSetIntentDiscrepancyList", "traits": { - "smithy.api#enumValue": "Ascending" + "smithy.api#documentation": "Contains information about discrepancies found for intents between the test set and the bot.
", + "smithy.api#required": {} } }, - "Descending": { - "target": "smithy.api#Unit", + "slotDiscrepancies": { + "target": "com.amazonaws.lexmodelsv2#TestSetSlotDiscrepancyList", "traits": { - "smithy.api#enumValue": "Descending" + "smithy.api#documentation": "Contains information about discrepancies found for slots between the test set and the bot.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Contains details about the errors in the test set discrepancy report
" } }, - "com.amazonaws.lexmodelsv2#Specifications": { + "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportBotAliasTarget": { "type": "structure", "members": { - "slotTypeId": { - "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier assigned to the slot type.
", + "smithy.api#documentation": "The unique identifier for the bot alias.
", "smithy.api#required": {} } }, - "valueElicitationSetting": { - "target": "com.amazonaws.lexmodelsv2#SubSlotValueElicitationSetting", + "botAliasId": { + "target": "com.amazonaws.lexmodelsv2#BotAliasId", "traits": { - "smithy.api#documentation": "Specifies the elicitation setting details for constituent sub slots of a composite slot.
", + "smithy.api#documentation": "The unique identifier for the bot associated with the bot alias.
", + "smithy.api#required": {} + } + }, + "localeId": { + "target": "com.amazonaws.lexmodelsv2#LocaleId", + "traits": { + "smithy.api#documentation": "The unique identifier of the locale associated with the bot alias.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Subslot specifications.
" + "smithy.api#documentation": "Contains information about the bot alias used for the \n test set discrepancy report.
" } }, - "com.amazonaws.lexmodelsv2#StartBotRecommendation": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse" + "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportResourceTarget": { + "type": "structure", + "members": { + "botAliasTarget": { + "target": "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportBotAliasTarget", + "traits": { + "smithy.api#documentation": "Contains information about the bot alias used as the resource for the\n test set discrepancy report.
" + } + } }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#ConflictException" - }, - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + "traits": { + "smithy.api#documentation": "Contains information about the resource used for the \n test set discrepancy report.
" + } + }, + "com.amazonaws.lexmodelsv2#TestSetDiscrepancyReportStatus": { + "type": "enum", + "members": { + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + "Completed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Completed" + } }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Use this to provide your transcript data, and to start the bot\n recommendation process.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations", - "code": 202 + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" + } } } }, - "com.amazonaws.lexmodelsv2#StartBotRecommendationRequest": { + "com.amazonaws.lexmodelsv2#TestSetExportSpecification": { "type": "structure", "members": { - "botId": { + "testSetId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The unique identifier of the test set.
", "smithy.api#required": {} } - }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the test set that is exported.
" + } + }, + "com.amazonaws.lexmodelsv2#TestSetGenerationDataSource": { + "type": "structure", + "members": { + "conversationLogsDataSource": { + "target": "com.amazonaws.lexmodelsv2#ConversationLogsDataSource", "traits": { - "smithy.api#documentation": "The version of the bot containing the bot recommendation.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Contains information about the bot from which the conversation logs are sourced.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the data source from which the test set is generated.
" + } + }, + "com.amazonaws.lexmodelsv2#TestSetGenerationStatus": { + "type": "enum", + "members": { + "Generating": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Generating" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "Ready": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "Ready" } }, - "transcriptSourceSetting": { - "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "Failed": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
", - "smithy.api#required": {} + "smithy.api#enumValue": "Failed" } }, - "encryptionSetting": { - "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "Pending": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The object representing the passwords that will be used to encrypt\n the data related to the bot recommendation results, as well as the KMS\n key ARN used to encrypt the associated metadata.
" + "smithy.api#enumValue": "Pending" } } } }, - "com.amazonaws.lexmodelsv2#StartBotRecommendationResponse": { + "com.amazonaws.lexmodelsv2#TestSetImportInputLocation": { "type": "structure", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", "traits": { - "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation.
" + "smithy.api#documentation": "The name of the Amazon S3 bucket.
", + "smithy.api#required": {} } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "s3Path": { + "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", "traits": { - "smithy.api#documentation": "The version of the bot containing the bot recommendation.
" + "smithy.api#documentation": "The path inside the Amazon S3 bucket pointing to the test-set CSV file.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the Amazon S3 location from which the test set is imported.
" + } + }, + "com.amazonaws.lexmodelsv2#TestSetImportResourceSpecification": { + "type": "structure", + "members": { + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The name of the test set.
", + "smithy.api#required": {} } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to start. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + "smithy.api#documentation": "The description of the test set.
" } }, - "botRecommendationStatus": { - "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", "traits": { - "smithy.api#documentation": "The status of the bot recommendation.
\nIf the status is Failed, then the reasons for the failure are listed\n in the failureReasons field.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role that has\n permission to access the test set.
", + "smithy.api#required": {} } }, - "botRecommendationId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", "traits": { - "smithy.api#documentation": "The identifier of the bot recommendation that you have\n created.
" + "smithy.api#documentation": "Contains information about the location that Amazon Lex uses to store the test-set.
", + "smithy.api#required": {} } }, - "creationDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", + "importInputLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetImportInputLocation", "traits": { - "smithy.api#documentation": "A timestamp of the date and time that the bot recommendation was\n created.
" + "smithy.api#documentation": "Contains information about the input location from where test-set should be imported.
", + "smithy.api#required": {} } }, - "transcriptSourceSetting": { - "target": "com.amazonaws.lexmodelsv2#TranscriptSourceSetting", + "modality": { + "target": "com.amazonaws.lexmodelsv2#TestSetModality", "traits": { - "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" + "smithy.api#documentation": "Specifies whether the test-set being imported contains written or spoken data.
", + "smithy.api#required": {} } }, - "encryptionSetting": { - "target": "com.amazonaws.lexmodelsv2#EncryptionSetting", + "testSetTags": { + "target": "com.amazonaws.lexmodelsv2#TagMap", "traits": { - "smithy.api#documentation": "The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" + "smithy.api#documentation": "A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the UpdateTestSet operation to update tags. To update tags, use the TagResource operation.
Starts importing a bot, bot locale, or custom vocabulary from a zip\n archive that you uploaded to an S3 bucket.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/imports", - "code": 202 - } + "smithy.api#documentation": "Contains information about the test set that is imported.
" } }, - "com.amazonaws.lexmodelsv2#StartImportRequest": { + "com.amazonaws.lexmodelsv2#TestSetIntentDiscrepancyItem": { "type": "structure", "members": { - "importId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "The unique identifier for the import. It is included in the response\n from the CreateUploadUrl operation.
", - "smithy.api#required": {} - } - }, - "resourceSpecification": { - "target": "com.amazonaws.lexmodelsv2#ImportResourceSpecification", + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "Parameters for creating the bot, bot locale or custom\n vocabulary.
", + "smithy.api#documentation": "The name of the intent in the discrepancy report.
", "smithy.api#required": {} } }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelsv2#MergeStrategy", + "errorMessage": { + "target": "com.amazonaws.lexmodelsv2#String", "traits": { - "smithy.api#documentation": "The strategy to use when there is a name conflict between the\n imported resource and an existing resource. When the merge strategy is\n FailOnConflict existing resources are not overwritten\n and the import fails.
The error message for a discrepancy for an intent between the test set and the bot.
", "smithy.api#required": {} } - }, - "filePassword": { - "target": "com.amazonaws.lexmodelsv2#ImportExportFilePassword", - "traits": { - "smithy.api#documentation": "The password used to encrypt the zip archive that contains the\n resource definition. You should always encrypt the zip archive to\n protect it during transit between your site and Amazon Lex.
" - } } + }, + "traits": { + "smithy.api#documentation": "Contains information about discrepancy in an intent information between the test set and the \n bot.
" } }, - "com.amazonaws.lexmodelsv2#StartImportResponse": { - "type": "structure", + "com.amazonaws.lexmodelsv2#TestSetIntentDiscrepancyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#TestSetIntentDiscrepancyItem" + } + }, + "com.amazonaws.lexmodelsv2#TestSetModality": { + "type": "enum", "members": { - "importId": { - "target": "com.amazonaws.lexmodelsv2#Id", - "traits": { - "smithy.api#documentation": "A unique identifier for the import.
" - } - }, - "resourceSpecification": { - "target": "com.amazonaws.lexmodelsv2#ImportResourceSpecification", - "traits": { - "smithy.api#documentation": "The parameters used when importing the resource.
" - } - }, - "mergeStrategy": { - "target": "com.amazonaws.lexmodelsv2#MergeStrategy", - "traits": { - "smithy.api#documentation": "The strategy used when there was a name conflict between the\n imported resource and an existing resource. When the merge strategy is\n FailOnConflict existing resources are not overwritten\n and the import fails.
The current status of the import. When the status is\n Complete the bot, bot alias, or custom vocabulary is\n ready to use.
The date and time that the import request was created.
" + "smithy.api#enumValue": "Audio" } } } }, - "com.amazonaws.lexmodelsv2#StillWaitingResponseFrequency": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 300 - } - } - }, - "com.amazonaws.lexmodelsv2#StillWaitingResponseSpecification": { + "com.amazonaws.lexmodelsv2#TestSetSlotDiscrepancyItem": { "type": "structure", "members": { - "messageGroups": { - "target": "com.amazonaws.lexmodelsv2#MessageGroupsList", + "intentName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "One or more message groups, each containing one or more messages,\n that define the prompts that Amazon Lex sends to the user.
", + "smithy.api#documentation": "The name of the intent associated with the slot in the discrepancy report.
", "smithy.api#required": {} } }, - "frequencyInSeconds": { - "target": "com.amazonaws.lexmodelsv2#StillWaitingResponseFrequency", + "slotName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "How often a message should be sent to the user. Minimum of 1 second,\n maximum of 5 minutes.
", + "smithy.api#documentation": "The name of the slot in the discrepancy report.
", "smithy.api#required": {} } }, - "timeoutInSeconds": { - "target": "com.amazonaws.lexmodelsv2#StillWaitingResponseTimeout", + "errorMessage": { + "target": "com.amazonaws.lexmodelsv2#String", "traits": { - "smithy.api#documentation": "If Amazon Lex waits longer than this length of time for a response, it\n will stop sending messages.
", + "smithy.api#documentation": "The error message for a discrepancy for an intent between the test set and the bot.
", "smithy.api#required": {} } - }, - "allowInterrupt": { - "target": "com.amazonaws.lexmodelsv2#BoxedBoolean", - "traits": { - "smithy.api#documentation": "Indicates that the user can interrupt the response by speaking while\n the message is being played.
" - } } }, "traits": { - "smithy.api#documentation": "Defines the messages that Amazon Lex sends to a user to remind them that\n the bot is waiting for a response.
" - } - }, - "com.amazonaws.lexmodelsv2#StillWaitingResponseTimeout": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 900 - } + "smithy.api#documentation": "Contains information about discrepancy in a slot information between the test set and the bot.
" } }, - "com.amazonaws.lexmodelsv2#StopBotRecommendation": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#StopBotRecommendationRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#StopBotRecommendationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#ConflictException" - }, - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Stop an already running Bot Recommendation request.
", - "smithy.api#http": { - "method": "PUT", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation", - "code": 202 - } + "com.amazonaws.lexmodelsv2#TestSetSlotDiscrepancyList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#TestSetSlotDiscrepancyItem" } }, - "com.amazonaws.lexmodelsv2#StopBotRecommendationRequest": { - "type": "structure", + "com.amazonaws.lexmodelsv2#TestSetSortAttribute": { + "type": "enum", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "TestSetName": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier of the bot containing the bot\n recommendation to be stopped.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "TestSetName" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "LastUpdatedDateTime": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the bot containing the bot recommendation.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#enumValue": "LastUpdatedDateTime" } - }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + } + } + }, + "com.amazonaws.lexmodelsv2#TestSetSortBy": { + "type": "structure", + "members": { + "attribute": { + "target": "com.amazonaws.lexmodelsv2#TestSetSortAttribute", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot recommendation\n to stop. The string must match one of the supported locales. For more\n information, see Supported languages\n
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Specifies whether to sort the test sets by name or by the time they were last updated.
", "smithy.api#required": {} } }, - "botRecommendationId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "order": { + "target": "com.amazonaws.lexmodelsv2#SortOrder", "traits": { - "smithy.api#documentation": "The unique identifier of the bot recommendation to be\n stopped.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Specifies whether to sort in ascending or descending order.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Contains information about the methods by which to sort the test set.
" } }, - "com.amazonaws.lexmodelsv2#StopBotRecommendationResponse": { - "type": "structure", + "com.amazonaws.lexmodelsv2#TestSetStatus": { + "type": "enum", "members": { - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "Importing": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier of the bot containing the bot recommendation that \n is being stopped.
" + "smithy.api#enumValue": "Importing" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "PendingAnnotation": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The version of the bot containing the recommendation that is being \n stopped.
" + "smithy.api#enumValue": "PendingAnnotation" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "Deleting": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identifier of the language and locale of the bot response\n to stop. The string must match one of the supported locales. For more\n information, see Supported languages\n
" + "smithy.api#enumValue": "Deleting" } }, - "botRecommendationStatus": { - "target": "com.amazonaws.lexmodelsv2#BotRecommendationStatus", + "ValidationError": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The status of the bot recommendation. If the status is Failed, \n then the reasons for the failure are listed in the failureReasons field.
" + "smithy.api#enumValue": "ValidationError" } }, - "botRecommendationId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "Ready": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The unique identifier of the bot recommendation that is being\n stopped.
" + "smithy.api#enumValue": "Ready" } } } }, - "com.amazonaws.lexmodelsv2#String": { - "type": "string" - }, - "com.amazonaws.lexmodelsv2#StringMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lexmodelsv2#NonEmptyString" - }, - "value": { - "target": "com.amazonaws.lexmodelsv2#String" - } - }, - "com.amazonaws.lexmodelsv2#SubSlotExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 640 - }, - "smithy.api#pattern": "^[0-9A-Za-z_\\-\\s\\(\\)]+$" - } - }, - "com.amazonaws.lexmodelsv2#SubSlotSetting": { + "com.amazonaws.lexmodelsv2#TestSetStorageLocation": { "type": "structure", "members": { - "expression": { - "target": "com.amazonaws.lexmodelsv2#SubSlotExpression", + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", "traits": { - "smithy.api#documentation": "The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.
" + "smithy.api#documentation": "The name of the Amazon S3 bucket in which the test set is stored.
", + "smithy.api#required": {} } }, - "slotSpecifications": { - "target": "com.amazonaws.lexmodelsv2#SubSlotSpecificationMap", + "s3Path": { + "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", "traits": { - "smithy.api#documentation": "Specifications for the constituent sub slots of a composite slot.
" + "smithy.api#documentation": "The path inside the Amazon S3 bucket where the test set is stored.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service\n (KMS) key for encrypting the test set.
" } } }, "traits": { - "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" - } - }, - "com.amazonaws.lexmodelsv2#SubSlotSpecificationMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lexmodelsv2#Name" - }, - "value": { - "target": "com.amazonaws.lexmodelsv2#Specifications" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 6 - } + "smithy.api#documentation": "Contains information about the location in which the test set is stored.
" } }, - "com.amazonaws.lexmodelsv2#SubSlotTypeComposition": { + "com.amazonaws.lexmodelsv2#TestSetSummary": { "type": "structure", "members": { - "name": { + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the test set.
" + } + }, + "testSetName": { "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "Name of a constituent sub slot inside a composite slot.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the test set.
" } }, - "slotTypeId": { - "target": "com.amazonaws.lexmodelsv2#BuiltInOrCustomSlotTypeId", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The unique identifier assigned to a slot type. \n This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the test set.
" + } + }, + "modality": { + "target": "com.amazonaws.lexmodelsv2#TestSetModality", + "traits": { + "smithy.api#documentation": "Specifies whether the test set contains written or spoken data.
" + } + }, + "status": { + "target": "com.amazonaws.lexmodelsv2#TestSetStatus", + "traits": { + "smithy.api#documentation": "The status of the test set.
" + } + }, + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an IAM role\n that has permission to access the test set.
" + } + }, + "numTurns": { + "target": "com.amazonaws.lexmodelsv2#Count", + "traits": { + "smithy.api#documentation": "The number of turns in the test set.
" + } + }, + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", + "traits": { + "smithy.api#documentation": "Contains information about the location at which the test set is stored.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the test set was created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time at which the test set was last updated.
" } } }, "traits": { - "smithy.api#documentation": "Subslot type composition.
" + "smithy.api#documentation": "Contains summary information about the test set.
" } }, - "com.amazonaws.lexmodelsv2#SubSlotTypeList": { + "com.amazonaws.lexmodelsv2#TestSetSummaryList": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#SubSlotTypeComposition" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 6 - } + "target": "com.amazonaws.lexmodelsv2#TestSetSummary" } }, - "com.amazonaws.lexmodelsv2#SubSlotValueElicitationSetting": { + "com.amazonaws.lexmodelsv2#TestSetTurnRecord": { "type": "structure", "members": { - "defaultValueSpecification": { - "target": "com.amazonaws.lexmodelsv2#SlotDefaultValueSpecification" - }, - "promptSpecification": { - "target": "com.amazonaws.lexmodelsv2#PromptSpecification", + "recordNumber": { + "target": "com.amazonaws.lexmodelsv2#RecordNumber", "traits": { + "smithy.api#documentation": "The record number associated with the turn.
", "smithy.api#required": {} } }, - "sampleUtterances": { - "target": "com.amazonaws.lexmodelsv2#SampleUtterancesList", + "conversationId": { + "target": "com.amazonaws.lexmodelsv2#TestSetConversationId", "traits": { - "smithy.api#documentation": "If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value, \n you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable \n of understanding user utterances. This is similar to SampleUtterances for slots.
The unique identifier for the conversation associated with the turn.
" } }, - "waitAndContinueSpecification": { - "target": "com.amazonaws.lexmodelsv2#WaitAndContinueSpecification" + "turnNumber": { + "target": "com.amazonaws.lexmodelsv2#TurnNumber", + "traits": { + "smithy.api#documentation": "The number of turns that has elapsed up to that turn.
" + } + }, + "turnSpecification": { + "target": "com.amazonaws.lexmodelsv2#TurnSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the agent or user turn depending upon type of turn.
", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "Subslot elicitation settings.
\n\n DefaultValueSpecification is a list of default values for a constituent sub slot in a composite slot. Default values are used when \n Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, \n session attributes, and defined values. This is similar to DefaultValueSpecification for slots.
\n PromptSpecification is the prompt that Amazon Lex uses to elicit the sub slot value from the user. \n This is similar to PromptSpecification for slots.
Contains information about a turn in a test set.
" } }, - "com.amazonaws.lexmodelsv2#TagKeyList": { + "com.amazonaws.lexmodelsv2#TestSetTurnRecordList": { "type": "list", "member": { - "target": "com.amazonaws.lexmodelsv2#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lexmodelsv2#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.lexmodelsv2#TagKey" - }, - "value": { - "target": "com.amazonaws.lexmodelsv2#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.lexmodelsv2#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.lexmodelsv2#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.lexmodelsv2#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.lexmodelsv2#InternalServerException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ThrottlingException" - }, - { - "target": "com.amazonaws.lexmodelsv2#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "Adds the specified tags to the specified resource. If a tag key\n already exists, the existing value is replaced with the new\n value.
", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceARN}", - "code": 200 - } + "target": "com.amazonaws.lexmodelsv2#TestSetTurnRecord" } }, - "com.amazonaws.lexmodelsv2#TagResourceRequest": { + "com.amazonaws.lexmodelsv2#TestSetTurnResult": { "type": "structure", "members": { - "resourceARN": { - "target": "com.amazonaws.lexmodelsv2#AmazonResourceName", + "agent": { + "target": "com.amazonaws.lexmodelsv2#AgentTurnResult", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel\n to tag.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Contains information about the agent messages in the turn.
" } }, - "tags": { - "target": "com.amazonaws.lexmodelsv2#TagMap", + "user": { + "target": "com.amazonaws.lexmodelsv2#UserTurnResult", "traits": { - "smithy.api#documentation": "A list of tag keys to add to the resource. If a tag key already\n exists, the existing value is replaced with the new value.
", - "smithy.api#required": {} + "smithy.api#documentation": "Contains information about the user messages in the turn.
" } } + }, + "traits": { + "smithy.api#documentation": "Contains information about the results of the analysis of a turn in the test set.
" } }, - "com.amazonaws.lexmodelsv2#TagResourceResponse": { - "type": "structure", - "members": {} - }, - "com.amazonaws.lexmodelsv2#TagValue": { + "com.amazonaws.lexmodelsv2#TestSetUtteranceText": { "type": "string", "traits": { "smithy.api#length": { - "min": 0, - "max": 256 + "min": 1, + "max": 1024 } } }, @@ -14386,12 +17770,12 @@ "lexTranscriptFilter": { "target": "com.amazonaws.lexmodelsv2#LexTranscriptFilter", "traits": { - "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript when the transcript format is the Amazon Lex\n format.
" + "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript when the transcript format is the Amazon Lex\n format.
" } } }, "traits": { - "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript.
" + "smithy.api#documentation": "The object representing the filter that Amazon Lex will use to select the\n appropriate transcript.
" } }, "com.amazonaws.lexmodelsv2#TranscriptFormat": { @@ -14411,12 +17795,41 @@ "s3BucketTranscriptSource": { "target": "com.amazonaws.lexmodelsv2#S3BucketTranscriptSource", "traits": { - "smithy.api#documentation": "Indicates the setting of the Amazon S3 bucket where the transcript is\n stored.
" + "smithy.api#documentation": "Indicates the setting of the Amazon S3 bucket where the transcript is\n stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Indicates the setting of the location where the transcript is\n stored.
" + } + }, + "com.amazonaws.lexmodelsv2#TurnNumber": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.lexmodelsv2#TurnSpecification": { + "type": "structure", + "members": { + "agentTurn": { + "target": "com.amazonaws.lexmodelsv2#AgentTurnSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the agent messages in the turn.
" + } + }, + "userTurn": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the user messages in the turn.
" } } }, "traits": { - "smithy.api#documentation": "Indicates the setting of the location where the transcript is\n stored.
" + "smithy.api#documentation": "Contains information about the messages in the turn.
" } }, "com.amazonaws.lexmodelsv2#UntagResource": { @@ -14469,11 +17882,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lexmodelsv2#UpdateBot": { "type": "operation", @@ -14602,6 +18021,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateBotAliasResponse": { @@ -14670,6 +18092,9 @@ "smithy.api#documentation": "A timestamp of the date and time that the bot was last\n updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateBotLocale": { @@ -14755,6 +18180,9 @@ "smithy.api#documentation": "The new Amazon Polly voice Amazon Lex should use for voice interaction with the\n user.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateBotLocaleResponse": { @@ -14832,6 +18260,9 @@ "smithy.api#documentation": "Recommended actions to take to resolve an error in the\n failureReasons field.
The object representing the passwords that were used to encrypt the\n data related to the bot recommendation results, as well as the KMS key\n ARN used to encrypt the associated metadata.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateBotRequest": { @@ -15034,6 +18471,9 @@ "smithy.api#documentation": "The list of bot members in the network associated \n with the update action.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateBotResponse": { @@ -15105,6 +18545,9 @@ "smithy.api#documentation": "The list of bot members in the network that was updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateCustomVocabularyItemsList": { @@ -15173,6 +18616,9 @@ "smithy.api#documentation": "The new password to use to encrypt the export zip archive.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateExportResponse": { @@ -15214,6 +18660,9 @@ "smithy.api#documentation": "The date and time that the export was last updated.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateIntent": { @@ -15364,9 +18813,12 @@ "initialResponseSetting": { "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateIntentResponse": { @@ -15483,9 +18935,12 @@ "initialResponseSetting": { "target": "com.amazonaws.lexmodelsv2#InitialResponseSetting", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Configuration settings for a response sent to the user before Amazon Lex starts eliciting slots.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateResourcePolicy": { @@ -15550,6 +19005,9 @@ "smithy.api#httpQuery": "expectedRevisionId" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateResourcePolicyResponse": { @@ -15567,6 +19025,9 @@ "smithy.api#documentation": "The current revision of the resource policy. Use the revision ID to\n make sure that you are updating the most current version of a resource\n policy when you add a policy statement to a resource, delete a\n resource, or update a resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lexmodelsv2#UpdateSlot": { @@ -15693,6 +19154,9 @@ "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.lexmodelsv2#UpdateSlotResponse": { @@ -15743,7 +19207,7 @@ "botVersion": { "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", "traits": { - "smithy.api#documentation": "The identifier of the slot version that contains the slot. Will\n always be DRAFT.
The version of the bot that contains the slot. Will\n always be DRAFT.
Indicates whether the slot accepts multiple values in one\n response.
" } }, - "subSlotSetting": { - "target": "com.amazonaws.lexmodelsv2#SubSlotSetting", + "subSlotSetting": { + "target": "com.amazonaws.lexmodelsv2#SubSlotSetting", + "traits": { + "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.lexmodelsv2#UpdateSlotType": { + "type": "operation", + "input": { + "target": "com.amazonaws.lexmodelsv2#UpdateSlotTypeRequest" + }, + "output": { + "target": "com.amazonaws.lexmodelsv2#UpdateSlotTypeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lexmodelsv2#ConflictException" + }, + { + "target": "com.amazonaws.lexmodelsv2#InternalServerException" + }, + { + "target": "com.amazonaws.lexmodelsv2#PreconditionFailedException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ThrottlingException" + }, + { + "target": "com.amazonaws.lexmodelsv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration of an existing slot type.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}", + "code": 202 + } + } + }, + "com.amazonaws.lexmodelsv2#UpdateSlotTypeRequest": { + "type": "structure", + "members": { + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the slot type to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "slotTypeName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The new name of the slot type.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", + "traits": { + "smithy.api#documentation": "The new description of the slot type.
" + } + }, + "slotTypeValues": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeValues", + "traits": { + "smithy.api#documentation": "A new list of values and their optional synonyms that define the\n values that the slot type can take.
" + } + }, + "valueSelectionSetting": { + "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", + "traits": { + "smithy.api#documentation": "The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.
" + } + }, + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", + "traits": { + "smithy.api#documentation": "The new built-in slot type that should be used as the parent of this\n slot type.
" + } + }, + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot that contains the slot type.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot type. Must be\n DRAFT.
The identifier of the language and locale that contains the slot\n type. The string must match one of the supported locales. For more\n information, see Supported languages.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" + }, + "compositeSlotTypeSetting": { + "target": "com.amazonaws.lexmodelsv2#CompositeSlotTypeSetting", + "traits": { + "smithy.api#documentation": "Specifications for a composite slot type.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#UpdateSlotTypeResponse": { + "type": "structure", + "members": { + "slotTypeId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The unique identifier of the updated slot type.
" + } + }, + "slotTypeName": { + "target": "com.amazonaws.lexmodelsv2#Name", + "traits": { + "smithy.api#documentation": "The updated name of the slot type.
" + } + }, + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", + "traits": { + "smithy.api#documentation": "The updated description of the slot type.
" + } + }, + "slotTypeValues": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeValues", + "traits": { + "smithy.api#documentation": "The updated values that the slot type provides.
" + } + }, + "valueSelectionSetting": { + "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", + "traits": { + "smithy.api#documentation": "The updated strategy that Amazon Lex uses to determine which value to\n select from the slot type.
" + } + }, + "parentSlotTypeSignature": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", + "traits": { + "smithy.api#documentation": "The updated signature of the built-in slot type that is the parent\n of this slot type.
" + } + }, + "botId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The identifier of the bot that contains the slot type.
" + } + }, + "botVersion": { + "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "traits": { + "smithy.api#documentation": "The version of the bot that contains the slot type. This is always\n DRAFT.
The language and locale of the updated slot type.
" + } + }, + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the date and time that the slot type was\n created.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" + } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" + }, + "compositeSlotTypeSetting": { + "target": "com.amazonaws.lexmodelsv2#CompositeSlotTypeSetting", "traits": { - "smithy.api#documentation": "Specifications for the constituent sub slots and the \n expression for the composite slot.
" + "smithy.api#documentation": "Specifications for a composite slot type.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#UpdateSlotType": { + "com.amazonaws.lexmodelsv2#UpdateTestSet": { "type": "operation", "input": { - "target": "com.amazonaws.lexmodelsv2#UpdateSlotTypeRequest" + "target": "com.amazonaws.lexmodelsv2#UpdateTestSetRequest" }, "output": { - "target": "com.amazonaws.lexmodelsv2#UpdateSlotTypeResponse" + "target": "com.amazonaws.lexmodelsv2#UpdateTestSetResponse" }, "errors": [ { @@ -15813,169 +19480,309 @@ } ], "traits": { - "smithy.api#documentation": "Updates the configuration of an existing slot type.
", + "smithy.api#documentation": "The action to update the test set.
", "smithy.api#http": { "method": "PUT", - "uri": "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/{slotTypeId}", - "code": 202 - } + "uri": "/testsets/{testSetId}", + "code": 200 + }, + "smithy.api#idempotent": {} } }, - "com.amazonaws.lexmodelsv2#UpdateSlotTypeRequest": { + "com.amazonaws.lexmodelsv2#UpdateTestSetRequest": { "type": "structure", "members": { - "slotTypeId": { + "testSetId": { "target": "com.amazonaws.lexmodelsv2#Id", "traits": { - "smithy.api#documentation": "The unique identifier of the slot type to update.
", + "smithy.api#documentation": "The test set Id for which update test operation to be performed.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "slotTypeName": { + "testSetName": { "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The new name of the slot type.
", + "smithy.api#documentation": "The new test set name.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The new description of the slot type.
" + "smithy.api#documentation": "The new test set description.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.lexmodelsv2#UpdateTestSetResponse": { + "type": "structure", + "members": { + "testSetId": { + "target": "com.amazonaws.lexmodelsv2#Id", + "traits": { + "smithy.api#documentation": "The test set Id for which update test operation to be performed.
" } }, - "slotTypeValues": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeValues", + "testSetName": { + "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "A new list of values and their optional synonyms that define the\n values that the slot type can take.
" + "smithy.api#documentation": "The test set name for the updated test set.
" } }, - "valueSelectionSetting": { - "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", + "description": { + "target": "com.amazonaws.lexmodelsv2#Description", "traits": { - "smithy.api#documentation": "The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.
" + "smithy.api#documentation": "The test set description for the updated test set.
" } }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", + "modality": { + "target": "com.amazonaws.lexmodelsv2#TestSetModality", "traits": { - "smithy.api#documentation": "The new built-in slot type that should be used as the parent of this\n slot type.
" + "smithy.api#documentation": "Indicates whether audio or text is used for the updated test set.
" } }, - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "status": { + "target": "com.amazonaws.lexmodelsv2#TestSetStatus", "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the slot type.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The status for the updated test set.
" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "roleArn": { + "target": "com.amazonaws.lexmodelsv2#RoleArn", "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot type. Must be\n DRAFT.
The roleARN used for any operation in the test set to access \n resources in the Amazon Web Services account.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "numTurns": { + "target": "com.amazonaws.lexmodelsv2#Count", "traits": { - "smithy.api#documentation": "The identifier of the language and locale that contains the slot\n type. The string must match one of the supported locales. For more\n information, see Supported languages.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The number of conversation turns from the updated test set.
" } }, - "externalSourceSetting": { - "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" + "storageLocation": { + "target": "com.amazonaws.lexmodelsv2#TestSetStorageLocation", + "traits": { + "smithy.api#documentation": "The Amazon S3 storage location for the updated test set.
" + } }, - "compositeSlotTypeSetting": { - "target": "com.amazonaws.lexmodelsv2#CompositeSlotTypeSetting", + "creationDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", "traits": { - "smithy.api#documentation": "Specifications for a composite slot type.
" + "smithy.api#documentation": "The creation date and time for the updated test set.
" + } + }, + "lastUpdatedDateTime": { + "target": "com.amazonaws.lexmodelsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time of the last update for the updated test set.
" } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.lexmodelsv2#UpdateSlotTypeResponse": { + "com.amazonaws.lexmodelsv2#UserTurnInputSpecification": { "type": "structure", "members": { - "slotTypeId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "utteranceInput": { + "target": "com.amazonaws.lexmodelsv2#UtteranceInputSpecification", "traits": { - "smithy.api#documentation": "The unique identifier of the updated slot type.
" + "smithy.api#documentation": "The utterance input in the user turn.
", + "smithy.api#required": {} } }, - "slotTypeName": { + "requestAttributes": { + "target": "com.amazonaws.lexmodelsv2#StringMap", + "traits": { + "smithy.api#documentation": "Request attributes of the user turn.
" + } + }, + "sessionState": { + "target": "com.amazonaws.lexmodelsv2#InputSessionStateSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the session state in the input.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the user messages in the turn in the input.
" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnIntentOutput": { + "type": "structure", + "members": { + "name": { "target": "com.amazonaws.lexmodelsv2#Name", "traits": { - "smithy.api#documentation": "The updated name of the slot type.
" + "smithy.api#documentation": "The name of the intent.
", + "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.lexmodelsv2#Description", + "slots": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSlotOutputMap", "traits": { - "smithy.api#documentation": "The updated description of the slot type.
" + "smithy.api#documentation": "The slots associated with the intent.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the intent that is output for the turn by the test execution.
" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnOutputSpecification": { + "type": "structure", + "members": { + "intent": { + "target": "com.amazonaws.lexmodelsv2#UserTurnIntentOutput", + "traits": { + "smithy.api#documentation": "Contains information about the intent.
", + "smithy.api#required": {} } }, - "slotTypeValues": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeValues", + "activeContexts": { + "target": "com.amazonaws.lexmodelsv2#ActiveContextList", "traits": { - "smithy.api#documentation": "The updated values that the slot type provides.
" + "smithy.api#documentation": "The contexts that are active in the turn.
" } }, - "valueSelectionSetting": { - "target": "com.amazonaws.lexmodelsv2#SlotValueSelectionSetting", + "transcript": { + "target": "com.amazonaws.lexmodelsv2#TestSetUtteranceText", "traits": { - "smithy.api#documentation": "The updated strategy that Amazon Lex uses to determine which value to\n select from the slot type.
" + "smithy.api#documentation": "The transcript that is output for the user turn by the test execution.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains results that are output for the user turn by the test execution.
" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnResult": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.lexmodelsv2#UserTurnInputSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the user messages in the turn in the input.
", + "smithy.api#required": {} } }, - "parentSlotTypeSignature": { - "target": "com.amazonaws.lexmodelsv2#SlotTypeSignature", + "expectedOutput": { + "target": "com.amazonaws.lexmodelsv2#UserTurnOutputSpecification", "traits": { - "smithy.api#documentation": "The updated signature of the built-in slot type that is the parent\n of this slot type.
" + "smithy.api#documentation": "Contains information about the expected output for the user turn.
", + "smithy.api#required": {} } }, - "botId": { - "target": "com.amazonaws.lexmodelsv2#Id", + "actualOutput": { + "target": "com.amazonaws.lexmodelsv2#UserTurnOutputSpecification", "traits": { - "smithy.api#documentation": "The identifier of the bot that contains the slot type.
" + "smithy.api#documentation": "Contains information about the actual output for the user turn.
" } }, - "botVersion": { - "target": "com.amazonaws.lexmodelsv2#DraftBotVersion", + "errorDetails": { + "target": "com.amazonaws.lexmodelsv2#ExecutionErrorDetails" + }, + "endToEndResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "The version of the bot that contains the slot type. This is always\n DRAFT.
Specifies whether the expected and actual outputs match or not, or if there is an error in execution.
" } }, - "localeId": { - "target": "com.amazonaws.lexmodelsv2#LocaleId", + "intentMatchResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "The language and locale of the updated slot type.
" + "smithy.api#documentation": "Specifies whether the expected and actual intents match or not.
" } }, - "creationDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", + "slotMatchResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "The timestamp of the date and time that the slot type was\n created.
" + "smithy.api#documentation": "Specifies whether the expected and actual slots match or not.
" } }, - "lastUpdatedDateTime": { - "target": "com.amazonaws.lexmodelsv2#Timestamp", + "speechTranscriptionResult": { + "target": "com.amazonaws.lexmodelsv2#TestResultMatchStatus", "traits": { - "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" + "smithy.api#documentation": "Specifies whether the expected and actual speech transcriptions match or not, or if there is an error in execution.
" } }, - "externalSourceSetting": { - "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" + "conversationLevelResult": { + "target": "com.amazonaws.lexmodelsv2#ConversationLevelResultDetail", + "traits": { + "smithy.api#documentation": "Contains information about the results related to the conversation associated with the user turn.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the results for the user turn by the test execution.
" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnSlotOutput": { + "type": "structure", + "members": { + "value": { + "target": "com.amazonaws.lexmodelsv2#NonEmptyString", + "traits": { + "smithy.api#documentation": "The value output by the slot recognition.
" + } }, - "compositeSlotTypeSetting": { - "target": "com.amazonaws.lexmodelsv2#CompositeSlotTypeSetting", + "values": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSlotOutputList", "traits": { - "smithy.api#documentation": "Specifications for a composite slot type.
" + "smithy.api#documentation": "Values that are output by the slot recognition.
" + } + }, + "subSlots": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSlotOutputMap", + "traits": { + "smithy.api#documentation": "A list of items mapping the name of the subslots to information about those subslots.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a slot output by the test set execution.
" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnSlotOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSlotOutput" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnSlotOutputMap": { + "type": "map", + "key": { + "target": "com.amazonaws.lexmodelsv2#Name" + }, + "value": { + "target": "com.amazonaws.lexmodelsv2#UserTurnSlotOutput" + } + }, + "com.amazonaws.lexmodelsv2#UserTurnSpecification": { + "type": "structure", + "members": { + "input": { + "target": "com.amazonaws.lexmodelsv2#UserTurnInputSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the user messages in the turn in the input.
", + "smithy.api#required": {} + } + }, + "expected": { + "target": "com.amazonaws.lexmodelsv2#UserTurnOutputSpecification", + "traits": { + "smithy.api#documentation": "Contains results about the expected output for the user turn.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Contains information about the expected and input values for the user turn.
" } }, "com.amazonaws.lexmodelsv2#Utterance": { @@ -15993,7 +19800,91 @@ } }, "traits": { - "smithy.api#documentation": "Provides parameters for setting the time window and duration for\n aggregating utterance data.
" + "smithy.api#documentation": "Provides parameters for setting the time window and duration for\n aggregating utterance data.
" + } + }, + "com.amazonaws.lexmodelsv2#UtteranceAudioInputSpecification": { + "type": "structure", + "members": { + "audioFileS3Location": { + "target": "com.amazonaws.lexmodelsv2#AudioFileS3Location", + "traits": { + "smithy.api#documentation": "Amazon S3 file pointing to the audio.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the audio for an utterance.
" + } + }, + "com.amazonaws.lexmodelsv2#UtteranceInputSpecification": { + "type": "structure", + "members": { + "textInput": { + "target": "com.amazonaws.lexmodelsv2#TestSetUtteranceText", + "traits": { + "smithy.api#documentation": "A text input transcription of the utterance. It is only applicable for test-sets containing text data.
" + } + }, + "audioInput": { + "target": "com.amazonaws.lexmodelsv2#UtteranceAudioInputSpecification", + "traits": { + "smithy.api#documentation": "Contains information about the audio input for an utterance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about input of an utterance.
" + } + }, + "com.amazonaws.lexmodelsv2#UtteranceLevelTestResultItem": { + "type": "structure", + "members": { + "recordNumber": { + "target": "com.amazonaws.lexmodelsv2#RecordNumber", + "traits": { + "smithy.api#documentation": "The record number of the result.
", + "smithy.api#required": {} + } + }, + "conversationId": { + "target": "com.amazonaws.lexmodelsv2#TestSetConversationId", + "traits": { + "smithy.api#documentation": "The unique identifier for the conversation associated with the result.
" + } + }, + "turnResult": { + "target": "com.amazonaws.lexmodelsv2#TestSetTurnResult", + "traits": { + "smithy.api#documentation": "Contains information about the turn associated with the result.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about multiple utterances in the results of a test set execution.
" + } + }, + "com.amazonaws.lexmodelsv2#UtteranceLevelTestResultItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#UtteranceLevelTestResultItem" + } + }, + "com.amazonaws.lexmodelsv2#UtteranceLevelTestResults": { + "type": "structure", + "members": { + "items": { + "target": "com.amazonaws.lexmodelsv2#UtteranceLevelTestResultItemList", + "traits": { + "smithy.api#documentation": "Contains information about an utterance in the results of the test set execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the utterances in the results of the test set execution.
" } }, "com.amazonaws.lexmodelsv2#ValidationException": { @@ -16051,7 +19942,7 @@ "engine": { "target": "com.amazonaws.lexmodelsv2#VoiceEngine", "traits": { - "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.
Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the \n engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.
If you do not specify a value, the default is standard.
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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AppCategory": { @@ -673,6 +676,9 @@ "smithy.api#documentation": "An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachDisk": { @@ -759,6 +765,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachInstancesToLoadBalancer": { @@ -832,6 +841,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachLoadBalancerTlsCertificate": { @@ -905,6 +917,9 @@ "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.
\nThese SSL/TLS certificates are only usable by Lightsail load balancers. You can't get\n the certificate and use it for another purpose.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachStaticIp": { @@ -978,6 +993,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#AttachedDisk": { @@ -1873,7 +1891,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the full details of an Amazon Lightsail SSL/TLS certificate.
\nTo get a summary of a certificate, use the GetCertificates action and ommit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
Describes the full details of an Amazon Lightsail SSL/TLS certificate.
\nTo get a summary of a certificate, use the GetCertificates action and omit\n includeCertificateDetails from your request. The response will include only\n the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.
An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CloudFormationStackRecord": { @@ -3128,6 +3149,9 @@ "smithy.api#documentation": "An array of objects that describe one or more container services.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CookieObject": { @@ -3245,6 +3269,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CostEstimate": { @@ -3368,6 +3395,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateBucketRequest": { @@ -3419,6 +3449,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateCertificate": { @@ -3504,6 +3537,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateCloudFormationStack": { @@ -3570,6 +3606,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContactMethod": { @@ -3640,6 +3679,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerService": { @@ -3747,6 +3789,9 @@ "smithy.api#documentation": "An object that describes a container service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerServiceRegistryLogin": { @@ -3799,6 +3844,9 @@ "smithy.api#documentation": "An object that describes the log in information for the container service registry of your\n Lightsail account.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateContainerServiceRequest": { @@ -3863,6 +3911,9 @@ "smithy.api#documentation": "An object that describes a container service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDisk": { @@ -4019,6 +4070,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDiskRequest": { @@ -4071,6 +4125,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDiskSnapshot": { @@ -4155,6 +4212,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDistribution": { @@ -4269,6 +4329,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDomain": { @@ -4382,6 +4445,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateDomainRequest": { @@ -4414,6 +4480,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateGUISessionAccessDetails": { @@ -4498,6 +4567,9 @@ "smithy.api#documentation": "Returns information about the specified NICE DCV GUI session.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstanceSnapshot": { @@ -4577,6 +4649,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstances": { @@ -4757,6 +4832,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateInstancesRequest": { @@ -4841,6 +4919,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateKeyPair": { @@ -4931,6 +5012,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateLoadBalancer": { @@ -5047,6 +5131,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateLoadBalancerTlsCertificate": { @@ -5139,6 +5226,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabase": { @@ -5293,6 +5383,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseRequest": { @@ -5383,6 +5476,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#CreateRelationalDatabaseSnapshot": { @@ -5462,6 +5558,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#Currency": { @@ -5536,6 +5635,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteAutoSnapshot": { @@ -5606,6 +5708,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteBucket": { @@ -5707,6 +5812,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteBucketRequest": { @@ -5739,6 +5847,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteCertificate": { @@ -5799,6 +5910,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteContactMethod": { @@ -5862,6 +5976,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteContainerImage": { @@ -5924,7 +6041,10 @@ }, "com.amazonaws.lightsail#DeleteContainerImageResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lightsail#DeleteContainerService": { "type": "operation", @@ -5978,7 +6098,10 @@ }, "com.amazonaws.lightsail#DeleteContainerServiceResult": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.lightsail#DeleteDisk": { "type": "operation", @@ -6050,6 +6173,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDiskSnapshot": { @@ -6116,6 +6242,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDistribution": { @@ -6178,6 +6307,9 @@ "smithy.api#documentation": "An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDomain": { @@ -6291,6 +6423,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteDomainRequest": { @@ -6317,6 +6452,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteInstance": { @@ -6389,6 +6527,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteInstanceSnapshot": { @@ -6455,6 +6596,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteKeyPair": { @@ -6527,6 +6671,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteKnownHostKeys": { @@ -6593,6 +6740,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancer": { @@ -6659,6 +6809,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteLoadBalancerTlsCertificate": { @@ -6738,6 +6891,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabase": { @@ -6816,6 +6972,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DeleteRelationalDatabaseSnapshot": { @@ -6882,6 +7041,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DestinationInfo": { @@ -6965,6 +7127,9 @@ "smithy.api#documentation": "An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachDisk": { @@ -7031,6 +7196,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachInstancesFromLoadBalancer": { @@ -7104,6 +7272,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DetachStaticIp": { @@ -7170,6 +7341,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#DisableAddOn": { @@ -7240,6 +7414,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#Disk": { @@ -7995,6 +8172,9 @@ "smithy.api#documentation": "The timestamp when the default key pair was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#EligibleToRenew": { @@ -8068,6 +8248,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#EndpointRequest": { @@ -8350,6 +8533,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#ForwardValues": { @@ -8444,6 +8630,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetActiveNames request and\n specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetAlarms request and\n specify the next page token using the pageToken parameter.
An array of objects that describe the automatic snapshots that are available for the\n specified source instance or disk.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBlueprints": { @@ -8682,6 +8877,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetBlueprints request and\n specify the next page token using the pageToken parameter.
An object that describes the access keys for the specified bucket.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBucketBundles": { @@ -8798,6 +8999,9 @@ "smithy.api#documentation": "An object that describes bucket bundles.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBucketMetricData": { @@ -8907,6 +9111,9 @@ "smithy.api#documentation": "An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBuckets": { @@ -8990,6 +9197,9 @@ "smithy.api#documentation": "An object that describes the synchronization status of the Amazon S3 account-level\n block public access feature for your Lightsail buckets.
\nFor more information about this feature and how it affects Lightsail buckets, see Block public access for buckets in Amazon Lightsail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetBundles": { @@ -9073,6 +9283,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetBundles request and\n specify the next page token using the pageToken parameter.
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
\nTo get a summary of a certificate, ommit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
\nTo get a summary of a certificate, omit includeCertificateDetails from\n your request. The response will include only the certificate Amazon Resource Name (ARN),\n certificate name, domain name, and tags.
The name for the certificate for which to return information.
\nWhen omitted, the response includes all of your certificates in the Amazon Web Services\n Region where the request is made.
" } + }, + "pageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nTo get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.
An object that describes certificates.
" } + }, + "nextPageToken": { + "target": "com.amazonaws.lightsail#string", + "traits": { + "smithy.api#documentation": "If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another\n GetCloudFormationStackRecords request and specify the next page token using the\n pageToken parameter.
An array of objects that describe the contact methods.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerAPIMetadata": { @@ -9324,6 +9558,9 @@ "smithy.api#documentation": "Metadata about Lightsail containers, such as the current version of the Lightsail\n Control (lightsailctl) plugin.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerImages": { @@ -9385,6 +9622,9 @@ "smithy.api#documentation": "An array of objects that describe container images that are registered to the container\n service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerLog": { @@ -9488,6 +9728,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetContainerLog request and\n specify the next page token using the pageToken parameter.
An array of objects that describe deployments for a container service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServiceMetricData": { @@ -9657,6 +9903,9 @@ "smithy.api#documentation": "An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServicePowers": { @@ -9709,6 +9958,9 @@ "smithy.api#documentation": "An array of objects that describe the powers that can be specified for a container\n service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetContainerServices": { @@ -9807,14 +10059,14 @@ "startTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "The cost estimate start time.
\nConstraints:
\nSpecified in Coordinated Universal Time (UTC).
\nSpecified in the Unix time format.
\nFor example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify\n 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", + "smithy.api#documentation": "The cost estimate start time.
\nConstraints:
\nSpecified in Coordinated Universal Time (UTC).
\nSpecified in the Unix time format.
\nFor example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify\n 1538424000 as the start time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.lightsail#IsoDate", "traits": { - "smithy.api#documentation": "The cost estimate end time.
\nConstraints:
\nSpecified in Coordinated Universal Time (UTC).
\nSpecified in the Unix time format.
\nFor example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify\n 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", + "smithy.api#documentation": "The cost estimate end time.
\nConstraints:
\nSpecified in Coordinated Universal Time (UTC).
\nSpecified in the Unix time format.
\nFor example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify\n 1538427600 as the end time.
You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
", "smithy.api#required": {} } } @@ -9832,6 +10084,9 @@ "smithy.api#documentation": "Returns the estimate's forecasted cost or usage.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDisk": { @@ -9898,6 +10153,9 @@ "smithy.api#documentation": "An object containing information about the disk.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDiskSnapshot": { @@ -9964,6 +10222,9 @@ "smithy.api#documentation": "An object containing information about the disk snapshot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDiskSnapshots": { @@ -10035,6 +10296,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetDiskSnapshots request and\n specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetDisks request and specify\n the next page token using the pageToken parameter.
An object that describes a distribution bundle.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributionLatestCacheReset": { @@ -10229,6 +10499,9 @@ "smithy.api#documentation": "The timestamp of the last cache reset (e.g., 1479734909.17) in Unix time\n format.
An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDistributions": { @@ -10415,6 +10691,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetDistributions request and\n specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about your get domain request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetDomains": { @@ -10552,6 +10834,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetDomains request and\n specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetExportSnapshotRecords\n request and specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about a get instance access\n request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceMetricData": { @@ -10850,6 +11141,9 @@ "smithy.api#documentation": "An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstancePortStates": { @@ -10916,6 +11210,9 @@ "smithy.api#documentation": "An array of objects that describe the firewall port states for the specified\n instance.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceRequest": { @@ -10942,6 +11239,9 @@ "smithy.api#documentation": "An array of key-value pairs containing information about the specified instance.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshot": { @@ -11008,6 +11308,9 @@ "smithy.api#documentation": "An array of key-value pairs containing information about the results of your get instance\n snapshot request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstanceSnapshots": { @@ -11079,6 +11382,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetInstanceSnapshots request\n and specify the next page token using the pageToken parameter.
The state of the instance.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetInstances": { @@ -11216,6 +11525,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetInstances request and\n specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about the key pair.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetKeyPairs": { @@ -11359,6 +11674,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetKeyPairs request and\n specify the next page token using the pageToken parameter.
An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerRequest": { @@ -11540,6 +11861,9 @@ "smithy.api#documentation": "An object containing information about your load balancer.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsCertificates": { @@ -11606,6 +11930,9 @@ "smithy.api#documentation": "An array of LoadBalancerTlsCertificate objects describing your SSL/TLS\n certificates.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetLoadBalancerTlsPolicies": { @@ -11671,6 +11998,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetLoadBalancerTlsPolicies\n request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetLoadBalancers request and\n specify the next page token using the pageToken parameter.
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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetOperations": { @@ -11933,6 +12269,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetOperationsForResource\n request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetOperations request and\n specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about your get regions request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabase": { @@ -12146,6 +12491,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another\n GetRelationalDatabaseBlueprints request and specify the next page token using\n the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetRelationalDatabaseBundles\n request and specify the next page token using the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetRelationalDatabaseEvents\n request and specify the next page token using the pageToken parameter.
A token used for advancing to the next page of results from your get relational database\n log events request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseLogStreams": { @@ -12482,6 +12839,9 @@ "smithy.api#documentation": "An object describing the result of your get relational database log streams\n request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMasterUserPassword": { @@ -12560,6 +12920,9 @@ "smithy.api#documentation": "The timestamp when the specified version of the master user password was created.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseMetricData": { @@ -12675,6 +13038,9 @@ "smithy.api#documentation": "An array of objects that describe the metric data returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseParameters": { @@ -12753,6 +13119,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another\n GetRelationalDatabaseParameters request and specify the next page token using\n the pageToken parameter.
An object describing the specified database.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshot": { @@ -12845,6 +13217,9 @@ "smithy.api#documentation": "An object describing the specified database snapshot.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetRelationalDatabaseSnapshots": { @@ -12916,6 +13291,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another\n GetRelationalDatabaseSnapshots request and specify the next page token using\n the pageToken parameter.
The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetRelationalDatabases\n request and specify the next page token using the pageToken parameter.
An array of key-value pairs containing information about the requested static IP.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#GetStaticIps": { @@ -13124,6 +13508,9 @@ "smithy.api#documentation": "The token to advance to the next page of results from your request.
\nA next page token is not returned if there are no more results to display.
\nTo get the next page of results, perform another GetStaticIps request and\n specify the next page token using the pageToken parameter.
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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#InUseResourceCount": { @@ -14508,6 +14898,9 @@ "smithy.api#documentation": "Returns true if the Lightsail VPC is peered; otherwise,\n false.
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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#Operation": { @@ -18376,6 +18772,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#PendingMaintenanceAction": { @@ -18765,6 +19164,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#PutInstancePublicPorts": { @@ -18838,6 +19240,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#QueryStringObject": { @@ -18973,6 +19378,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#RebootRelationalDatabase": { @@ -19039,6 +19447,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#RecordState": { @@ -19282,6 +19693,9 @@ "smithy.api#documentation": "An object that describes a container image that is registered to a Lightsail container\n service
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#RegisteredDomainDelegationInfo": { @@ -19981,6 +20395,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#RenewalStatus": { @@ -20122,6 +20539,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#ResourceArn": { @@ -20458,6 +20878,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#SensitiveNonEmptyString": { @@ -20608,6 +21031,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#SetResourceAccessForBucket": { @@ -20682,6 +21108,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StartGUISession": { @@ -20742,6 +21171,9 @@ "smithy.api#documentation": "The available API operations.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StartInstance": { @@ -20808,6 +21240,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StartRelationalDatabase": { @@ -20874,6 +21309,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StaticIp": { @@ -21084,6 +21522,9 @@ "smithy.api#documentation": "The available API operations.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StopInstance": { @@ -21176,6 +21617,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StopRelationalDatabase": { @@ -21248,6 +21692,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#StringList": { @@ -21383,6 +21830,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#TagValue": { @@ -21456,6 +21906,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#TimeOfDay": { @@ -21591,6 +22044,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UntagResource": { @@ -21670,6 +22126,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateBucket": { @@ -21771,6 +22230,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateBucketRequest": { @@ -21827,6 +22289,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateContainerService": { @@ -21918,6 +22383,9 @@ "smithy.api#documentation": "An object that describes a container service.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDistribution": { @@ -22023,6 +22491,9 @@ "smithy.api#documentation": "An object that describes the result of the action, such as the status of the request, the\n timestamp of the request, and the resources affected by the request.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDistributionRequest": { @@ -22079,6 +22550,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateDomainEntry": { @@ -22152,6 +22626,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateInstanceMetadataOptions": { @@ -22242,6 +22719,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateLoadBalancerAttribute": { @@ -22322,6 +22802,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabase": { @@ -22435,6 +22918,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#UpdateRelationalDatabaseRequest": { @@ -22515,6 +23001,9 @@ "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.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.lightsail#boolean": { diff --git a/codegen/sdk-codegen/aws-models/location.2020-11-19.json b/codegen/sdk-codegen/aws-models/location.2020-11-19.json index e2b650b049d..0602e2c087c 100644 --- a/codegen/sdk-codegen/aws-models/location.2020-11-19.json +++ b/codegen/sdk-codegen/aws-models/location.2020-11-19.json @@ -98,7 +98,7 @@ "smithy.api#documentation": "A list of allowed actions that an API key resource grants permissions to\n perform
\nCurrently, the only valid action is geo:GetMap* as an input to the\n list. For example, [\"geo:GetMap*\"] is valid but\n [\"geo:GetMapTile\"] is not.
Contains the details of the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.
\nEach \n geofence polygon can have a maximum of 1,000 vertices.
\nSpecifies additional user-defined properties to store with the Geofence. An array \n of key-value pairs.
" + } } }, "traits": { @@ -875,7 +881,7 @@ } ], "traits": { - "smithy.api#documentation": "Uploads position update data for one or more devices to a tracker resource. Amazon Location\n uses the data when it reports the last known device position and position history. Amazon Location retains location data for 30 \n days.
\nPosition updates are handled based on the PositionFiltering property of the tracker. \n When PositionFiltering is set to TimeBased, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. If your update frequency is more often than \n every 30 seconds, only one update per 30 seconds is stored for each unique device ID.
When PositionFiltering is set to DistanceBased filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased filtering,\n location data is stored and evaluated against linked geofence collections only if the\n device has moved more than the measured accuracy. For example, if two consecutive\n updates from a device have a horizontal accuracy of 5 m and 10 m, the second update\n is neither stored or evaluated if the device has moved less than 15 m. If\n PositionFiltering is set to AccuracyBased filtering, Amazon Location\n uses the default value { \"Horizontal\": 0} when accuracy is not provided on\n a DevicePositionUpdate.
Uploads position update data for one or more devices to a tracker resource (up to \n 10 devices per batch). Amazon Location uses the data when it reports the last known device \n position and position history. Amazon Location retains location data for 30 days.
\nPosition updates are handled based on the PositionFiltering \n property of the tracker. When PositionFiltering is set to \n TimeBased, updates are evaluated against linked geofence collections, \n and location data is stored at a maximum of one position per 30 second interval. \n If your update frequency is more often than every 30 seconds, only one update per \n 30 seconds is stored for each unique device ID.
When PositionFiltering is set to DistanceBased \n filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than 30 m (98.4 ft).
When PositionFiltering is set to AccuracyBased \n filtering, location data is stored and evaluated against linked geofence \n collections only if the device has moved more than the measured accuracy. For \n example, if two consecutive updates from a device have a horizontal accuracy of \n 5 m and 10 m, the second update is neither stored or evaluated if the device has \n moved less than 15 m. If PositionFiltering is set to \n AccuracyBased filtering, Amazon Location uses the default value \n { \"Horizontal\": 0} when accuracy is not provided on a\n DevicePositionUpdate.
Contains the position update details for each device.
", + "smithy.api#documentation": "Contains the position update details for each device, up to 10 devices.
", "smithy.api#length": { "min": 1, "max": 10 @@ -3415,6 +3421,18 @@ ] } }, + "com.amazonaws.location#FilterPlaceCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, "com.amazonaws.location#GenericResource": { "type": "resource", "identifiers": { @@ -3830,6 +3848,12 @@ "smithy.api#documentation": "The timestamp for when the geofence collection was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n
Contains additional user-defined properties stored with the geofence. An array of \n key-value pairs.
" + } } } }, @@ -4796,6 +4820,12 @@ "smithy.api#documentation": "The timestamp for when the geofence was last updated in ISO 8601\n format: YYYY-MM-DDThh:mm:ss.sssZ\n
Contains additional user-defined properties stored with the geofence. An array of \n key-value pairs.
" + } } }, "traits": { @@ -6606,19 +6636,31 @@ "TimeZone": { "target": "com.amazonaws.location#TimeZone", "traits": { - "smithy.api#documentation": "The time zone in which the Place is located. Returned only when using\n HERE as the selected partner.
The time zone in which the Place is located. Returned only when using\n HERE or Grab as the selected partner.
For addresses with a UnitNumber, the type of unit. For example,\n Apartment.
For addresses with a UnitNumber, the type of unit. For example,\n Apartment.
Returned only for a place index that uses Esri as a data provider.
\nFor 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.
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 or Grab as a data provider. Is \n not returned for SearchPlaceIndexForPosition.
The Amazon Location categories that describe this Place.
\nFor more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.
" + } + }, + "SupplementalCategories": { + "target": "com.amazonaws.location#PlaceSupplementalCategoryList", + "traits": { + "smithy.api#documentation": "Categories from the data provider that describe the Place that are not mapped\n to any Amazon Location categories.
" } } }, @@ -6626,6 +6668,26 @@ "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#PlaceCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 35 + } + } + }, + "com.amazonaws.location#PlaceCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.location#PlaceGeometry": { "type": "structure", "members": { @@ -6696,6 +6758,26 @@ } } }, + "com.amazonaws.location#PlaceSupplementalCategory": { + "type": "string", + "traits": { + "smithy.api#length": { + "max": 35 + } + } + }, + "com.amazonaws.location#PlaceSupplementalCategoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.location#PlaceSupplementalCategory" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.location#Position": { "type": "list", "member": { @@ -6867,6 +6949,12 @@ "smithy.api#documentation": "Contains the details to specify the position of the geofence. Can be either a \n polygon or a circle. Including both will return a validation error.
\nEach \n geofence polygon can have a maximum of 1,000 vertices.
\nSpecifies additional user-defined properties to store with the Geofence. An array \n of key-value pairs.
" + } } } }, @@ -7124,7 +7212,19 @@ "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 returned by place indexes that use Esri, Grab, or HERE\n as data providers.
The unique identifier of the Place. You can use this with the GetPlace\n operation to find the place again later, or to get full information for the Place.
The GetPlace request must use the same PlaceIndex \n resource as the SearchPlaceIndexForSuggestions that generated the Place \n ID.
For SearchPlaceIndexForSuggestions operations, the\n PlaceId is returned by place indexes that use Esri, Grab, or HERE\n as data providers.
The Amazon Location categories that describe the Place.
\nFor more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.
" + } + }, + "SupplementalCategories": { + "target": "com.amazonaws.location#PlaceSupplementalCategoryList", + "traits": { + "smithy.api#documentation": "Categories from the data provider that describe the Place that are not mapped\n to any Amazon Location categories.
" } } }, @@ -7400,6 +7500,12 @@ "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. If no language is specified,\n or not supported for a particular result, the partner automatically chooses a language\n for the result.
\nFor an example, we'll use the Greek language. You search for Athens, Gr\n to get suggestions with the language parameter set to en. The\n results found will most likely be returned as Athens, Greece.
If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα, Ελλάδα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.
\nFor more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.
" + } } } }, @@ -7468,6 +7574,12 @@ "traits": { "smithy.api#documentation": "The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.
The optional category filter specified in the request.
" + } } }, "traits": { @@ -7563,6 +7675,12 @@ "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 Athens,\n Greece, with the language parameter set to en. The\n result found will most likely be returned as Athens.
If you set the language parameter to el, for Greek, then the\n result found will more likely be returned as Αθήνα.
If the data provider does not have a value for Greek, the result will be in a language\n that the provider does support.
" } + }, + "FilterCategories": { + "target": "com.amazonaws.location#FilterPlaceCategoryList", + "traits": { + "smithy.api#documentation": "A list of one or more Amazon Location categories to filter the returned places. If you \n include more than one category, the results will include results that match \n any of the categories listed.
\nFor more information about using categories, including a list of Amazon Location\n categories, see Categories and filtering, in the Amazon Location Service Developer \n Guide.
" + } } } }, @@ -7638,6 +7756,12 @@ "traits": { "smithy.api#documentation": "The preferred language used to return results. Matches the language in the request.\n The value is a valid BCP 47\n language tag, for example, en for English.
The optional category filter specified in the request.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json b/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json index 4929aa573e0..bcce7710be5 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json +++ b/codegen/sdk-codegen/aws-models/opensearch.2021-01-01.json @@ -2766,7 +2766,13 @@ "Endpoint": { "target": "com.amazonaws.opensearch#Endpoint", "traits": { - "smithy.api#documentation": "The endpoint of the remote domain.
" + "smithy.api#documentation": "The Endpoint attribute cannot be modified.
\nThe endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
" + } + }, + "CrossClusterSearch": { + "target": "com.amazonaws.opensearch#CrossClusterSearchConnectionProperties", + "traits": { + "smithy.api#documentation": "The connection properties for cross cluster search.
" } } }, @@ -3009,6 +3015,12 @@ "traits": { "smithy.api#documentation": "The connection mode.
" } + }, + "ConnectionProperties": { + "target": "com.amazonaws.opensearch#ConnectionProperties", + "traits": { + "smithy.api#documentation": "The ConnectionProperties for the outbound connection.
Status of SkipUnavailable param for outbound connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Cross cluster search specific connection properties.
" + } + }, "com.amazonaws.opensearch#DeleteDomain": { "type": "operation", "input": { @@ -4597,11 +4623,6 @@ "type": "list", "member": { "target": "com.amazonaws.opensearch#DescribePackagesFilterValue" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } } }, "com.amazonaws.opensearch#DescribePackagesRequest": { @@ -9929,6 +9950,26 @@ "smithy.api#documentation": "The domain endpoint to which index and search requests are submitted. For example,\n search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or\n doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.
Status of SkipUnavailable param for outbound connection.
\n\n ENABLED - The SkipUnavailable param is enabled\n for the connection.
\n\n DISABLED - The SkipUnavailable param is disabled\n for the connection.
\nYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion1": { + "type": "structure", + "members": { + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion2": { + "type": "structure", + "members": { + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals3", + "traits": { + "smithy.api#documentation": "The service code of the AMEX payment card. This is different from the Card Security Code (CSC).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#AsymmetricEncryptionAttributes": { + "type": "structure", + "members": { + "PaddingType": { + "target": "com.amazonaws.paymentcryptographydata#PaddingType", + "traits": { + "smithy.api#documentation": "The padding to be included with the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters for plaintext encryption using asymmetric keys.
" + } + }, + "com.amazonaws.paymentcryptographydata#CardGenerationAttributes": { + "type": "union", + "members": { + "AmexCardSecurityCodeVersion1": { + "target": "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion1" + }, + "AmexCardSecurityCodeVersion2": { + "target": "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion2", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" + } + }, + "CardVerificationValue1": { + "target": "com.amazonaws.paymentcryptographydata#CardVerificationValue1", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.
" + } + }, + "CardVerificationValue2": { + "target": "com.amazonaws.paymentcryptographydata#CardVerificationValue2", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.
" + } + }, + "CardHolderVerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#CardHolderVerificationValue", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate a cardholder verification value for the payment card.
" + } + }, + "DynamicCardVerificationCode": { + "target": "com.amazonaws.paymentcryptographydata#DynamicCardVerificationCode", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.
" + } + }, + "DynamicCardVerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#DynamicCardVerificationValue", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
" + } + }, + "com.amazonaws.paymentcryptographydata#CardHolderVerificationValue": { + "type": "structure", + "members": { + "UnpredictableNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And8", + "traits": { + "smithy.api#documentation": "A random number generated by the issuer.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter value that comes from a point of sale terminal.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to generate a cardholder verification value for the payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#CardVerificationAttributes": { + "type": "union", + "members": { + "AmexCardSecurityCodeVersion1": { + "target": "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion1" + }, + "AmexCardSecurityCodeVersion2": { + "target": "com.amazonaws.paymentcryptographydata#AmexCardSecurityCodeVersion2", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.
" + } + }, + "CardVerificationValue1": { + "target": "com.amazonaws.paymentcryptographydata#CardVerificationValue1", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.
" + } + }, + "CardVerificationValue2": { + "target": "com.amazonaws.paymentcryptographydata#CardVerificationValue2", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" + } + }, + "CardHolderVerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#CardHolderVerificationValue", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify a cardholder verification value for the payment card.
" + } + }, + "DynamicCardVerificationCode": { + "target": "com.amazonaws.paymentcryptographydata#DynamicCardVerificationCode", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" + } + }, + "DynamicCardVerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#DynamicCardVerificationValue", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.
" + } + }, + "DiscoverDynamicCardVerificationCode": { + "target": "com.amazonaws.paymentcryptographydata#DiscoverDynamicCardVerificationCode", + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
" + } + }, + "com.amazonaws.paymentcryptographydata#CardVerificationValue1": { + "type": "structure", + "members": { + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals3", + "traits": { + "smithy.api#documentation": "The service code of the payment card. This is different from Card Security Code (CSC).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify CVV (Card Verification Value) for the payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#CardVerificationValue2": { + "type": "structure", + "members": { + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#CryptogramAuthResponse": { + "type": "union", + "members": { + "ArpcMethod1": { + "target": "com.amazonaws.paymentcryptographydata#CryptogramVerificationArpcMethod1", + "traits": { + "smithy.api#documentation": "Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" + } + }, + "ArpcMethod2": { + "target": "com.amazonaws.paymentcryptographydata#CryptogramVerificationArpcMethod2", + "traits": { + "smithy.api#documentation": "Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for Authorization Response Cryptogram (ARPC) generation after Authorization Request Cryptogram (ARQC) verification is successful.
" + } + }, + "com.amazonaws.paymentcryptographydata#CryptogramVerificationArpcMethod1": { + "type": "structure", + "members": { + "AuthResponseCode": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals4", + "traits": { + "smithy.api#documentation": "The auth code used to calculate APRC after ARQC verification is successful. This is the same auth code used for ARQC generation outside of Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" + } + }, + "com.amazonaws.paymentcryptographydata#CryptogramVerificationArpcMethod2": { + "type": "structure", + "members": { + "CardStatusUpdate": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals8", + "traits": { + "smithy.api#documentation": "The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.
", + "smithy.api#required": {} + } + }, + "ProprietaryAuthenticationData": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween1And16", + "traits": { + "smithy.api#documentation": "The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" + } + }, + "com.amazonaws.paymentcryptographydata#DecryptData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#DecryptDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#DecryptDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA. When you use DUKPT, for TDES algorithm, the ciphertext data length must be a multiple of 16 bytes. For AES algorithm, the ciphertext data length must be a multiple of 32 bytes.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n EncryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\nThe keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
The ciphertext to decrypt.
", + "smithy.api#required": {} + } + }, + "DecryptionAttributes": { + "target": "com.amazonaws.paymentcryptographydata#EncryptionDecryptionAttributes", + "traits": { + "smithy.api#documentation": "The encryption key type and attributes for ciphertext decryption.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#DecryptDataOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "PlainText": { + "target": "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4096", + "traits": { + "smithy.api#documentation": "The decrypted plaintext data.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#DiscoverDynamicCardVerificationCode": { + "type": "structure", + "members": { + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + }, + "UnpredictableNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And8", + "traits": { + "smithy.api#documentation": "A random number that is generated by the issuer.
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter value that comes from the terminal.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).
" + } + }, + "com.amazonaws.paymentcryptographydata#DukptAttributes": { + "type": "structure", + "members": { + "KeySerialNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween10And24", + "traits": { + "smithy.api#documentation": "The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
", + "smithy.api#required": {} + } + }, + "DukptDerivationType": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationType", + "traits": { + "smithy.api#documentation": "The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.
" + } + }, + "com.amazonaws.paymentcryptographydata#DukptDerivationAttributes": { + "type": "structure", + "members": { + "KeySerialNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween10And24", + "traits": { + "smithy.api#documentation": "The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
", + "smithy.api#required": {} + } + }, + "DukptKeyDerivationType": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationType", + "traits": { + "smithy.api#documentation": "The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY\n
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters required for encryption or decryption of data using DUKPT.
" + } + }, + "com.amazonaws.paymentcryptographydata#DukptDerivationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TDES_2KEY", + "name": "TDES_2KEY" + }, + { + "value": "TDES_3KEY", + "name": "TDES_3KEY" + }, + { + "value": "AES_128", + "name": "AES_128" + }, + { + "value": "AES_192", + "name": "AES_192" + }, + { + "value": "AES_256", + "name": "AES_256" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#DukptEncryptionAttributes": { + "type": "structure", + "members": { + "KeySerialNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween10And24", + "traits": { + "smithy.api#documentation": "The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
", + "smithy.api#required": {} + } + }, + "Mode": { + "target": "com.amazonaws.paymentcryptographydata#DukptEncryptionMode", + "traits": { + "smithy.api#documentation": "The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
\nThe default is CBC.
" + } + }, + "DukptKeyDerivationType": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationType", + "traits": { + "smithy.api#documentation": "The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY\n
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
" + } + }, + "InitializationVector": { + "target": "com.amazonaws.paymentcryptographydata#HexLength16Or32", + "traits": { + "smithy.api#documentation": "An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
Parameters that are required to encrypt plaintext data using DUKPT.
" + } + }, + "com.amazonaws.paymentcryptographydata#DukptEncryptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ECB", + "name": "ECB" + }, + { + "value": "CBC", + "name": "CBC" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#DukptKeyVariant": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BIDIRECTIONAL", + "name": "BIDIRECTIONAL" + }, + { + "value": "REQUEST", + "name": "REQUEST" + }, + { + "value": "RESPONSE", + "name": "RESPONSE" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#DynamicCardVerificationCode": { + "type": "structure", + "members": { + "UnpredictableNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And8", + "traits": { + "smithy.api#documentation": "A random number generated by the issuer.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter value that comes from the terminal.
", + "smithy.api#required": {} + } + }, + "TrackData": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And160", + "traits": { + "smithy.api#documentation": "The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" + } + }, + "com.amazonaws.paymentcryptographydata#DynamicCardVerificationValue": { + "type": "structure", + "members": { + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "CardExpiryDate": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals4", + "traits": { + "smithy.api#documentation": "The expiry date of a payment card.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals3", + "traits": { + "smithy.api#documentation": "The service code of the payment card. This is different from Card Security Code (CSC).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter value that comes from the terminal.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" + } + }, + "com.amazonaws.paymentcryptographydata#EncryptData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#EncryptDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#EncryptDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
\nYou can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey).
for symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, you must already have a DUKPT key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DecryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\n\n ReEncryptData\n
\nThe keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
The plaintext to be encrypted.
", + "smithy.api#required": {} + } + }, + "EncryptionAttributes": { + "target": "com.amazonaws.paymentcryptographydata#EncryptionDecryptionAttributes", + "traits": { + "smithy.api#documentation": "The encryption key type and attributes for plaintext encryption.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#EncryptDataOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "CipherText": { + "target": "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4096", + "traits": { + "smithy.api#documentation": "The encrypted ciphertext.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#EncryptionDecryptionAttributes": { + "type": "union", + "members": { + "Symmetric": { + "target": "com.amazonaws.paymentcryptographydata#SymmetricEncryptionAttributes", + "traits": { + "smithy.api#documentation": "Parameters that are required to perform encryption and decryption using symmetric keys.
" + } + }, + "Asymmetric": { + "target": "com.amazonaws.paymentcryptographydata#AsymmetricEncryptionAttributes" + }, + "Dukpt": { + "target": "com.amazonaws.paymentcryptographydata#DukptEncryptionAttributes" + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to perform encryption and decryption operations.
" + } + }, + "com.amazonaws.paymentcryptographydata#EncryptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ECB", + "name": "ECB" + }, + { + "value": "CBC", + "name": "CBC" + }, + { + "value": "CFB", + "name": "CFB" + }, + { + "value": "CFB1", + "name": "CFB1" + }, + { + "value": "CFB8", + "name": "CFB8" + }, + { + "value": "CFB64", + "name": "CFB64" + }, + { + "value": "CFB128", + "name": "CFB128" + }, + { + "value": "OFB", + "name": "OFB" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#GenerateCardValidationData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#GenerateCardValidationDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#GenerateCardValidationDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC). For more information, see Generate card data in the Amazon Web Services Payment Cryptography User Guide.
\nThis operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account Number) and expiration date of the card are required to check its validity during transaction processing. To begin this operation, a CVK (Card Verification Key) encryption key is required. You can use CreateKey or ImportKey to establish a CVK within Amazon Web Services Payment Cryptography. The KeyModesOfUse should be set to Generate and Verify for a CVK encryption key.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
", + "smithy.api#required": {} + } + }, + "GenerationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#CardGenerationAttributes", + "traits": { + "smithy.api#documentation": "The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "ValidationDataLength": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween3And5Type", + "traits": { + "smithy.api#documentation": "The length of the CVV or CSC to be generated. The default value is 3.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#GenerateCardValidationDataOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "ValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween3And5", + "traits": { + "smithy.api#documentation": "The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#GenerateMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#GenerateMacInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#GenerateMacOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
\nYou can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for comparision without sending or receiving data in ciphertext or plaintext. You can use this operation to generate a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n VerifyMac\n
\nThe keyARN of the MAC generation encryption key.
The data for which a MAC is under generation.
", + "smithy.api#required": {} + } + }, + "GenerationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#MacAttributes", + "traits": { + "smithy.api#documentation": "The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "MacLength": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And16", + "traits": { + "smithy.api#documentation": "The length of a MAC under generation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#GenerateMacOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "Mac": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween4And128", + "traits": { + "smithy.api#documentation": "The MAC cryptogram generated within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#GeneratePinData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#GeneratePinDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#GeneratePinDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see Generate PIN data in the Amazon Web Services Payment Cryptography User Guide.
\nPIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TranslatePinData\n
\n\n VerifyPinData\n
\nThe keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
The attributes and values to use for PIN, PVV, or PIN Offset generation.
", + "smithy.api#required": {} + } + }, + "PinDataLength": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And12", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The length of PIN under generation.
" + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
", + "smithy.api#required": {} + } + }, + "PinBlockFormat": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockFormatForPinData", + "traits": { + "smithy.api#documentation": "The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.
", + "smithy.api#required": {} + } + }, + "PinData": { + "target": "com.amazonaws.paymentcryptographydata#PinData", + "traits": { + "smithy.api#documentation": "The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4064": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 4064 + }, + "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4096": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 4096 + }, + "smithy.api#pattern": "^(?:[0-9a-fA-F][0-9a-fA-F])+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptographydata#HexLength16Or32": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 32 + }, + "smithy.api#pattern": "^(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween10And24": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 10, + "max": 24 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 32 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween1And16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween2And1024": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 1024 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween2And160": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 160 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4096": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4096 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween2And8": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 8 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthBetween4And128": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 128 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthEquals1": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + }, + "smithy.api#pattern": "^[0-9A-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthEquals16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthEquals2": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthEquals4": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 4 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#HexLengthEquals8": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 8, + "max": 8 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#Ibm3624NaturalPin": { + "type": "structure", + "members": { + "DecimalizationTable": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals16", + "traits": { + "smithy.api#documentation": "The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
", + "smithy.api#required": {} + } + }, + "PinValidationDataPadCharacter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals1", + "traits": { + "smithy.api#documentation": "The padding character for validation data.
", + "smithy.api#required": {} + } + }, + "PinValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16", + "traits": { + "smithy.api#documentation": "The unique data for cardholder identification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 natural PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#Ibm3624PinFromOffset": { + "type": "structure", + "members": { + "DecimalizationTable": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals16", + "traits": { + "smithy.api#documentation": "The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
", + "smithy.api#required": {} + } + }, + "PinValidationDataPadCharacter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals1", + "traits": { + "smithy.api#documentation": "The padding character for validation data.
", + "smithy.api#required": {} + } + }, + "PinValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16", + "traits": { + "smithy.api#documentation": "The unique data for cardholder identification.
", + "smithy.api#required": {} + } + }, + "PinOffset": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12", + "traits": { + "smithy.api#documentation": "The PIN offset value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#Ibm3624PinOffset": { + "type": "structure", + "members": { + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).
", + "smithy.api#required": {} + } + }, + "DecimalizationTable": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals16", + "traits": { + "smithy.api#documentation": "The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
", + "smithy.api#required": {} + } + }, + "PinValidationDataPadCharacter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals1", + "traits": { + "smithy.api#documentation": "The padding character for validation data.
", + "smithy.api#required": {} + } + }, + "PinValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16", + "traits": { + "smithy.api#documentation": "The unique data for cardholder identification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#Ibm3624PinVerification": { + "type": "structure", + "members": { + "DecimalizationTable": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals16", + "traits": { + "smithy.api#documentation": "The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
", + "smithy.api#required": {} + } + }, + "PinValidationDataPadCharacter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals1", + "traits": { + "smithy.api#documentation": "The padding character for validation data.
", + "smithy.api#required": {} + } + }, + "PinValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16", + "traits": { + "smithy.api#documentation": "The unique data for cardholder identification.
", + "smithy.api#required": {} + } + }, + "PinOffset": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12", + "traits": { + "smithy.api#documentation": "The PIN offset value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 PIN verification PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#Ibm3624RandomPin": { + "type": "structure", + "members": { + "DecimalizationTable": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthEquals16", + "traits": { + "smithy.api#documentation": "The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.
", + "smithy.api#required": {} + } + }, + "PinValidationDataPadCharacter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals1", + "traits": { + "smithy.api#documentation": "The padding character for validation data.
", + "smithy.api#required": {} + } + }, + "PinValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16", + "traits": { + "smithy.api#documentation": "The unique data for cardholder identification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 random PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#IntegerRangeBetween0And9": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9 + } + } + }, + "com.amazonaws.paymentcryptographydata#IntegerRangeBetween3And5Type": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 3, + "max": 5 + } + } + }, + "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And12": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 4, + "max": 12 + } + } + }, + "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And16": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 4, + "max": 16 + } + } + }, + "com.amazonaws.paymentcryptographydata#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.paymentcryptographydata#KeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 150 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptographydata#KeyArnOrKeyAliasType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 322 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$" + } + }, + "com.amazonaws.paymentcryptographydata#KeyCheckValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptographydata#MacAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ISO9797_ALGORITHM1", + "name": "ISO9797_ALGORITHM1" + }, + { + "value": "ISO9797_ALGORITHM3", + "name": "ISO9797_ALGORITHM3" + }, + { + "value": "CMAC", + "name": "CMAC" + }, + { + "value": "HMAC_SHA224", + "name": "HMAC_SHA224" + }, + { + "value": "HMAC_SHA256", + "name": "HMAC_SHA256" + }, + { + "value": "HMAC_SHA384", + "name": "HMAC_SHA384" + }, + { + "value": "HMAC_SHA512", + "name": "HMAC_SHA512" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt": { + "type": "structure", + "members": { + "KeySerialNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween10And24", + "traits": { + "smithy.api#documentation": "The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.
", + "smithy.api#required": {} + } + }, + "DukptKeyVariant": { + "target": "com.amazonaws.paymentcryptographydata#DukptKeyVariant", + "traits": { + "smithy.api#documentation": "The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
", + "smithy.api#required": {} + } + }, + "DukptDerivationType": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationType", + "traits": { + "smithy.api#documentation": "The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters required for DUKPT MAC generation and verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#MacAlgorithmEmv": { + "type": "structure", + "members": { + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "The method to use when deriving the master key for EMV MAC generation or verification.
", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "SessionKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyDerivationMode", + "traits": { + "smithy.api#documentation": "The method of deriving a session key for EMV MAC generation or verification.
", + "smithy.api#required": {} + } + }, + "SessionKeyDerivationValue": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyDerivationValue", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate session key for EMV generation and verification.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for EMV MAC generation and verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#MacAttributes": { + "type": "union", + "members": { + "Algorithm": { + "target": "com.amazonaws.paymentcryptographydata#MacAlgorithm", + "traits": { + "smithy.api#documentation": "The encryption algorithm for MAC generation or verification.
" + } + }, + "EmvMac": { + "target": "com.amazonaws.paymentcryptographydata#MacAlgorithmEmv", + "traits": { + "smithy.api#documentation": "Parameters that are required for MAC generation or verification using EMV MAC algorithm.
" + } + }, + "DukptIso9797Algorithm1": { + "target": "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt", + "traits": { + "smithy.api#documentation": "Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
" + } + }, + "DukptIso9797Algorithm3": { + "target": "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt", + "traits": { + "smithy.api#documentation": "Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
" + } + }, + "DukptCmac": { + "target": "com.amazonaws.paymentcryptographydata#MacAlgorithmDukpt", + "traits": { + "smithy.api#documentation": "Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMV_OPTION_A", + "name": "EMV_OPTION_A" + }, + { + "value": "EMV_OPTION_B", + "name": "EMV_OPTION_B" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 19 + }, + "smithy.api#pattern": "^[0-9]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthBetween3And5": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 5 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthEquals16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 16 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthEquals3": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 3 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#NumberLengthEquals4": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 4 + }, + "smithy.api#pattern": "^[0-9]+$" + } + }, + "com.amazonaws.paymentcryptographydata#PaddingType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PKCS1", + "name": "PKCS1" + }, + { + "value": "OAEP_SHA1", + "name": "OAEP_SHA1" + }, + { + "value": "OAEP_SHA256", + "name": "OAEP_SHA256" + }, + { + "value": "OAEP_SHA512", + "name": "OAEP_SHA512" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#PaymentCryptographyDataPlane": { + "type": "service", + "version": "2022-02-03", + "operations": [ + { + "target": "com.amazonaws.paymentcryptographydata#DecryptData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#EncryptData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#GenerateCardValidationData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#GenerateMac" + }, + { + "target": "com.amazonaws.paymentcryptographydata#GeneratePinData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ReEncryptData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#TranslatePinData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerifyAuthRequestCryptogram" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerifyCardValidationData" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerifyMac" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerifyPinData" + } + ], + "traits": { + "aws.api#dataPlane": {}, + "aws.api#service": { + "sdkId": "Payment Cryptography Data", + "endpointPrefix": "dataplane.payment-cryptography" + }, + "aws.auth#sigv4": { + "name": "payment-cryptography" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.
\nTo manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
", + "smithy.api#title": "Payment Cryptography Data Plane", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://dataplane.payment-cryptography.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://dataplane.payment-cryptography.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.paymentcryptographydata#PinBlockFormatForPinData": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ISO_FORMAT_0", + "name": "ISO_FORMAT_0" + }, + { + "value": "ISO_FORMAT_3", + "name": "ISO_FORMAT_3" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#PinData": { + "type": "union", + "members": { + "PinOffset": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12", + "traits": { + "smithy.api#documentation": "The PIN offset value.
" + } + }, + "VerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12", + "traits": { + "smithy.api#documentation": "The unique data to identify a cardholder. In most cases, this is the same as cardholder's Primary Account Number (PAN). If a value is not provided, it defaults to PAN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate, translate, or verify PIN data.
" + } + }, + "com.amazonaws.paymentcryptographydata#PinGenerationAttributes": { + "type": "union", + "members": { + "VisaPin": { + "target": "com.amazonaws.paymentcryptographydata#VisaPin", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PIN.
" + } + }, + "VisaPinVerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#VisaPinVerificationValue", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
" + } + }, + "Ibm3624PinOffset": { + "target": "com.amazonaws.paymentcryptographydata#Ibm3624PinOffset", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
" + } + }, + "Ibm3624NaturalPin": { + "target": "com.amazonaws.paymentcryptographydata#Ibm3624NaturalPin", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 natural PIN.
" + } + }, + "Ibm3624RandomPin": { + "target": "com.amazonaws.paymentcryptographydata#Ibm3624RandomPin", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 random PIN.
" + } + }, + "Ibm3624PinFromOffset": { + "target": "com.amazonaws.paymentcryptographydata#Ibm3624PinFromOffset", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for PIN data generation.
" + } + }, + "com.amazonaws.paymentcryptographydata#PinVerificationAttributes": { + "type": "union", + "members": { + "VisaPin": { + "target": "com.amazonaws.paymentcryptographydata#VisaPinVerification", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PIN.
" + } + }, + "Ibm3624Pin": { + "target": "com.amazonaws.paymentcryptographydata#Ibm3624PinVerification", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Ibm3624 PIN.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for PIN data verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#ReEncryptData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#ReEncryptDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#ReEncryptDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys.
\nYou can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt. In asymmetric encryption, ciphertext is encrypted using public component (imported by calling ImportKey) of the asymmetric key pair created outside of Amazon Web Services Payment Cryptography.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DecryptData\n
\n\n EncryptData\n
\n\n GetPublicCertificate\n
\n\n ImportKey\n
\nThe keyARN of the encryption key of incoming ciphertext data.
The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
", + "smithy.api#required": {} + } + }, + "IncomingEncryptionAttributes": { + "target": "com.amazonaws.paymentcryptographydata#ReEncryptionAttributes", + "traits": { + "smithy.api#documentation": "The attributes and values for incoming ciphertext.
", + "smithy.api#required": {} + } + }, + "OutgoingEncryptionAttributes": { + "target": "com.amazonaws.paymentcryptographydata#ReEncryptionAttributes", + "traits": { + "smithy.api#documentation": "The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#ReEncryptDataOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
", + "smithy.api#required": {} + } + }, + "KeyCheckValue": { + "target": "com.amazonaws.paymentcryptographydata#KeyCheckValue", + "traits": { + "smithy.api#documentation": "The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "CipherText": { + "target": "com.amazonaws.paymentcryptographydata#HexEvenLengthBetween16And4096", + "traits": { + "smithy.api#documentation": "The encrypted ciphertext.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#ReEncryptionAttributes": { + "type": "union", + "members": { + "Symmetric": { + "target": "com.amazonaws.paymentcryptographydata#SymmetricEncryptionAttributes", + "traits": { + "smithy.api#documentation": "Parameters that are required to encrypt data using symmetric keys.
" + } + }, + "Dukpt": { + "target": "com.amazonaws.paymentcryptographydata#DukptEncryptionAttributes" + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to perform reencryption operation.
" + } + }, + "com.amazonaws.paymentcryptographydata#ResourceNotFoundException": { + "type": "structure", + "members": { + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The resource that is missing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid resource error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyAmex": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Amex payment card.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyDerivation": { + "type": "union", + "members": { + "EmvCommon": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyEmvCommon", + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Emv common payment card for ARQC verification.
" + } + }, + "Mastercard": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyMastercard", + "traits": { + "smithy.api#documentation": "Parameters to derive session key for a Mastercard payment card for ARQC verification.
" + } + }, + "Emv2000": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyEmv2000", + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" + } + }, + "Amex": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyAmex", + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Amex payment card for ARQC verification.
" + } + }, + "Visa": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyVisa", + "traits": { + "smithy.api#documentation": "Parameters to derive session key for a Visa payment cardfor ARQC verification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive a session key for Authorization Response Cryptogram (ARQC) verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyDerivationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EMV_COMMON_SESSION_KEY", + "name": "EMV_COMMON_SESSION_KEY" + }, + { + "value": "EMV2000", + "name": "EMV2000" + }, + { + "value": "AMEX", + "name": "AMEX" + }, + { + "value": "MASTERCARD_SESSION_KEY", + "name": "MASTERCARD_SESSION_KEY" + }, + { + "value": "VISA", + "name": "VISA" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyDerivationValue": { + "type": "union", + "members": { + "ApplicationCryptogram": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals16", + "traits": { + "smithy.api#documentation": "The cryptogram provided by the terminal during transaction processing.
" + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter that is provided by the terminal during transaction processing.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key value using a MAC EMV algorithm.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyEmv2000": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter that is provided by the terminal during transaction processing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyEmvCommon": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter that is provided by the terminal during transaction processing.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key for an Emv common payment card for ARQC verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyMastercard": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + }, + "ApplicationTransactionCounter": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And4", + "traits": { + "smithy.api#documentation": "The transaction counter that is provided by the terminal during transaction processing.
", + "smithy.api#required": {} + } + }, + "UnpredictableNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween2And8", + "traits": { + "smithy.api#documentation": "A random number generated by the issuer.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key for Mastercard payment card for ARQC verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#SessionKeyVisa": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + }, + "PanSequenceNumber": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals2", + "traits": { + "smithy.api#documentation": "A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters to derive session key for Visa payment card for ARQC verification.
" + } + }, + "com.amazonaws.paymentcryptographydata#SymmetricEncryptionAttributes": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.paymentcryptographydata#EncryptionMode", + "traits": { + "smithy.api#documentation": "The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
", + "smithy.api#required": {} + } + }, + "InitializationVector": { + "target": "com.amazonaws.paymentcryptographydata#HexLength16Or32", + "traits": { + "smithy.api#documentation": "An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
The padding to be included with the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters requried to encrypt plaintext data using symmetric keys.
" + } + }, + "com.amazonaws.paymentcryptographydata#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.paymentcryptographydata#TranslatePinData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#TranslatePinDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#TranslatePinDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
\nPIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT tranlations. You can use this operation for P2PE (Point to Point Encryption) use cases where the encryption keys should change but the processing system either does not need to, or is not permitted to, decrypt the data.
The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\nAt this time, Amazon Web Services Payment Cryptography does not support translations to PIN format 4.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GeneratePinData\n
\n\n VerifyPinData\n
\nThe keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
The format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "OutgoingTranslationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#TranslationIsoFormats", + "traits": { + "smithy.api#documentation": "The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
", + "smithy.api#required": {} + } + }, + "IncomingDukptAttributes": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationAttributes", + "traits": { + "smithy.api#documentation": "The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.
" + } + }, + "OutgoingDukptAttributes": { + "target": "com.amazonaws.paymentcryptographydata#DukptDerivationAttributes", + "traits": { + "smithy.api#documentation": "The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#TranslatePinDataOutput": { + "type": "structure", + "members": { + "PinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The ougoing encrypted PIN block data after tranlation.
", + "smithy.api#required": {} + } + }, + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#TranslationIsoFormats": { + "type": "union", + "members": { + "IsoFormat0": { + "target": "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat034", + "traits": { + "smithy.api#documentation": "Parameters that are required for ISO9564 PIN format 0 tranlation.
" + } + }, + "IsoFormat1": { + "target": "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat1", + "traits": { + "smithy.api#documentation": "Parameters that are required for ISO9564 PIN format 1 tranlation.
" + } + }, + "IsoFormat3": { + "target": "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat034", + "traits": { + "smithy.api#documentation": "Parameters that are required for ISO9564 PIN format 3 tranlation.
" + } + }, + "IsoFormat4": { + "target": "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat034", + "traits": { + "smithy.api#documentation": "Parameters that are required for ISO9564 PIN format 4 tranlation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for translation between ISO9564 PIN block formats 0,1,3,4.
" + } + }, + "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat034": { + "type": "structure", + "members": { + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required for tranlation between ISO9564 PIN format 0,3,4 tranlation.
" + } + }, + "com.amazonaws.paymentcryptographydata#TranslationPinDataIsoFormat1": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "Parameters that are required for ISO9564 PIN format 1 tranlation.
" + } + }, + "com.amazonaws.paymentcryptographydata#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.paymentcryptographydata#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.paymentcryptographydata#ValidationExceptionField": { + "type": "structure", + "members": { + "path": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
" + } + }, + "com.amazonaws.paymentcryptographydata#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptographydata#ValidationExceptionField" + } + }, + "com.amazonaws.paymentcryptographydata#VerificationFailedException": { + "type": "structure", + "members": { + "Reason": { + "target": "com.amazonaws.paymentcryptographydata#VerificationFailedReason", + "traits": { + "smithy.api#documentation": "The reason for the exception.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "This request failed verification.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.paymentcryptographydata#VerificationFailedReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "INVALID_MAC", + "name": "INVALID_MAC" + }, + { + "value": "INVALID_PIN", + "name": "INVALID_PIN" + }, + { + "value": "INVALID_VALIDATION_DATA", + "name": "INVALID_VALIDATION_DATA" + }, + { + "value": "INVALID_AUTH_REQUEST_CRYPTOGRAM", + "name": "INVALID_AUTH_REQUEST_CRYPTOGRAM" + } + ] + } + }, + "com.amazonaws.paymentcryptographydata#VerifyAuthRequestCryptogram": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#VerifyAuthRequestCryptogramInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#VerifyAuthRequestCryptogramOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerificationFailedException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide.
\nARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling ImportKey. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling CreateKey to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2. The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n VerifyPinData\n
\nThe keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "AuthRequestCryptogram": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthEquals16", + "traits": { + "smithy.api#documentation": "The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
", + "smithy.api#required": {} + } + }, + "MajorKeyDerivationMode": { + "target": "com.amazonaws.paymentcryptographydata#MajorKeyDerivationMode", + "traits": { + "smithy.api#documentation": "The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "SessionKeyDerivationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#SessionKeyDerivation", + "traits": { + "smithy.api#documentation": "The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "AuthResponseAttributes": { + "target": "com.amazonaws.paymentcryptographydata#CryptogramAuthResponse", + "traits": { + "smithy.api#documentation": "The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyAuthRequestCryptogramOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "AuthResponseValue": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween1And16", + "traits": { + "smithy.api#documentation": "The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyCardValidationData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#VerifyCardValidationDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#VerifyCardValidationDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerificationFailedException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see Verify card data in the Amazon Web Services Payment Cryptography User Guide.
\nThis operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supporting platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and expiration date of the card to check its validity during transaction processing. In this operation, the CVK (Card Verification Key) encryption key for use with card data verification is same as the one in used for GenerateCardValidationData.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n VerifyPinData\n
\nThe keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
", + "smithy.api#required": {} + } + }, + "VerificationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#CardVerificationAttributes", + "traits": { + "smithy.api#documentation": "The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "ValidationData": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween3And5", + "traits": { + "smithy.api#documentation": "The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyCardValidationDataOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyMac": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#VerifyMacInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#VerifyMacOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerificationFailedException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies a Message Authentication Code (MAC).
\nYou can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for verification without sending or receiving data in ciphertext or plaintext. You can use this operation to verify a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. Use the same encryption key for MAC verification as you use for GenerateMac.
\nFor information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GenerateMac\n
\nThe keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
The data on for which MAC is under verification.
", + "smithy.api#required": {} + } + }, + "Mac": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween4And128", + "traits": { + "smithy.api#documentation": "The MAC being verified.
", + "smithy.api#required": {} + } + }, + "VerificationAttributes": { + "target": "com.amazonaws.paymentcryptographydata#MacAttributes", + "traits": { + "smithy.api#documentation": "The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
", + "smithy.api#required": {} + } + }, + "MacLength": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween4And16", + "traits": { + "smithy.api#documentation": "The length of the MAC.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyMacOutput": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyPinData": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptographydata#VerifyPinDataInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptographydata#VerifyPinDataOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptographydata#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#ValidationException" + }, + { + "target": "com.amazonaws.paymentcryptographydata#VerificationFailedException" + } + ], + "traits": { + "smithy.api#documentation": "Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.
\nThis operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n GeneratePinData\n
\n\n TranslatePinData\n
\nThe keyARN of the PIN verification key.
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
The attributes and values for PIN data verification.
", + "smithy.api#required": {} + } + }, + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
", + "smithy.api#required": {} + } + }, + "PrimaryAccountNumber": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween12And19", + "traits": { + "smithy.api#documentation": "The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
", + "smithy.api#required": {} + } + }, + "PinBlockFormat": { + "target": "com.amazonaws.paymentcryptographydata#PinBlockFormatForPinData", + "traits": { + "smithy.api#documentation": "The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The length of PIN being verified.
" + } + }, + "DukptAttributes": { + "target": "com.amazonaws.paymentcryptographydata#DukptAttributes", + "traits": { + "smithy.api#documentation": "The attributes and values for the DUKPT encrypted PIN block data.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptographydata#VerifyPinDataOutput": { + "type": "structure", + "members": { + "VerificationKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.paymentcryptographydata#KeyArn", + "traits": { + "smithy.api#documentation": "The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptographydata#VisaPin": { + "type": "structure", + "members": { + "PinVerificationKeyIndex": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween0And9", + "traits": { + "smithy.api#documentation": "The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#VisaPinVerification": { + "type": "structure", + "members": { + "PinVerificationKeyIndex": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween0And9", + "traits": { + "smithy.api#documentation": "The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
", + "smithy.api#required": {} + } + }, + "VerificationValue": { + "target": "com.amazonaws.paymentcryptographydata#NumberLengthBetween4And12", + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PIN.
" + } + }, + "com.amazonaws.paymentcryptographydata#VisaPinVerificationValue": { + "type": "structure", + "members": { + "EncryptedPinBlock": { + "target": "com.amazonaws.paymentcryptographydata#HexLengthBetween16And32", + "traits": { + "smithy.api#documentation": "The encrypted PIN block data to verify.
", + "smithy.api#required": {} + } + }, + "PinVerificationKeyIndex": { + "target": "com.amazonaws.paymentcryptographydata#IntegerRangeBetween0And9", + "traits": { + "smithy.api#documentation": "The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json b/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json new file mode 100644 index 00000000000..2ca3c2dded2 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/payment-cryptography.2021-09-14.json @@ -0,0 +1,3381 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.paymentcryptography#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "You do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.paymentcryptography#Alias": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.paymentcryptography#AliasName", + "traits": { + "smithy.api#documentation": "A friendly name that you can use to refer to a key. The value must begin with alias/.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe KeyARN of the key associated with the alias.
Contains information about an alias.
" + } + }, + "com.amazonaws.paymentcryptography#AliasName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 256 + }, + "smithy.api#pattern": "^alias/[a-zA-Z0-9/_-]+$" + } + }, + "com.amazonaws.paymentcryptography#Aliases": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#Alias" + } + }, + "com.amazonaws.paymentcryptography#CertificateType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32768 + }, + "smithy.api#pattern": "^[^\\[;\\]<>]+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptography#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This request can cause an inconsistent state for the resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.paymentcryptography#CreateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#CreateAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#CreateAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.
\nYou can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.
\nTo change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nA friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe KeyARN of the key to associate with the alias.
The alias for the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#CreateKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#CreateKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#CreateKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.
\nIn addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.
\nWhen you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n " + } + }, + "com.amazonaws.paymentcryptography#CreateKeyInput": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
\nFor DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
" + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable from the service.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
" + } + }, + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nTo use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nThe key material that contains all the key attributes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#DeleteAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#DeleteAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#DeleteAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes the alias, but doesn't affect the underlying key.
\nEach key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nA friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.
Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.
\nKey deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set DeleteKeyInDays. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
If you delete key material, you can use ImportKey to reimport the same key material into the Amazon Web Services Payment Cryptography key.
\nYou should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n RestoreKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nThe KeyARN of the key that is scheduled for deletion.
The waiting period for key deletion. The default value is seven days.
", + "smithy.api#range": { + "min": 3, + "max": 180 + } + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#DeleteKeyOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "smithy.api#documentation": "The KeyARN of the key that is scheduled for deletion.
Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
\nAmazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
\nYou can use ExportKey to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography
\n TR-34 key export\n
\nAmazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.
\nSet the following parameters:
\nThe KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.
Obtained from KDH by calling GetParametersForExport.
\nAmazon Web Services Payment Cryptography uses this to wrap the key under export.
\nWhen this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block.
\n\n TR-31 key export\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe key block format type, for example, TR-34 or TR-31, to use during key material export.
", + "smithy.api#required": {} + } + }, + "ExportKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
Parameter information for key material export using TR-31 standard.
" + } + }, + "Tr34KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ExportTr34KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material export using TR-34 standard.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material export from Amazon Web Services Payment Cryptography.
" + } + }, + "com.amazonaws.paymentcryptography#ExportKeyOutput": { + "type": "structure", + "members": { + "WrappedKey": { + "target": "com.amazonaws.paymentcryptography#WrappedKey", + "traits": { + "smithy.api#documentation": "The key material under export as a TR-34 or TR-31 wrapped key block.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ExportTokenId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^export-token-[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#ExportTr31KeyBlock": { + "type": "structure", + "members": { + "WrappingKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Parameter information for key material export using TR-31 standard.
" + } + }, + "com.amazonaws.paymentcryptography#ExportTr34KeyBlock": { + "type": "structure", + "members": { + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#required": {} + } + }, + "KeyBlockFormat": { + "target": "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat", + "traits": { + "smithy.api#documentation": "The format of key block that Amazon Web Services Payment Cryptography will use during key export.
", + "smithy.api#required": {} + } + }, + "RandomNonce": { + "target": "com.amazonaws.paymentcryptography#HexLength16", + "traits": { + "smithy.api#documentation": "A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material export using TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#GetAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the Amazon Web Services Payment Cryptography key associated with the alias.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n ListAliases\n
\n\n UpdateAlias\n
\nThe alias of the Amazon Web Services Payment Cryptography key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#GetAliasOutput": { + "type": "structure", + "members": { + "Alias": { + "target": "com.amazonaws.paymentcryptography#Alias", + "traits": { + "smithy.api#documentation": "The alias of the Amazon Web Services Payment Cryptography key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#GetKeyInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the Amazon Web Services Payment Cryptography key.
The key material, including the immutable and mutable data for the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetParametersForExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetParametersForExportInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetParametersForExportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
\nThe signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nThe key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.
The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. RSA_2048 is the only signing key algorithm allowed.
The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days.
", + "smithy.api#required": {} + } + }, + "SigningKeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + }, + "SigningKeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.
", + "smithy.api#required": {} + } + }, + "ParametersValidUntilTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The validity period of the export token.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetParametersForImport": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetParametersForImportInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetParametersForImportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
\nThe wrapping key certificate wraps the key under import within the TR-34 key payload. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. The same import token can be used to import multiple keys into your service account.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ImportKey\n
\nThe key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import TR34_KEY_BLOCK. Import token is not required for TR-31 key import.
The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. RSA_2048 is the only wrapping key algorithm allowed.
The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.
", + "smithy.api#required": {} + } + }, + "WrappingKeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + }, + "WrappingKeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm of the wrapping key for use within TR-34 key block. RSA_2048 is the only wrapping key algorithm allowed.
The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.
", + "smithy.api#required": {} + } + }, + "ParametersValidUntilTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The validity period of the import token.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#GetPublicKeyCertificate": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificateInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
\nUnlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#GetPublicKeyCertificateInput": { + "type": "structure", + "members": { + "KeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the asymmetric key pair.
The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days.
", + "smithy.api#required": {} + } + }, + "KeyCertificateChain": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#HexLength16": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 16, + "max": 16 + }, + "smithy.api#pattern": "^[0-9A-F]+$" + } + }, + "com.amazonaws.paymentcryptography#ImportKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ImportKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ImportKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Imports keys and public key certificates into Amazon Web Services Payment Cryptography.
\nAmazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.
\nYou can use ImportKey to import main or root keys such as KEK (Key Encryption Key) using asymmetric key exchange technique following the ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys.
After you have imported a main or root key, you can import working keys to perform various cryptographic operations within Amazon Web Services Payment Cryptography using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN.
\nYou can also import a root public key certificate, a self-signed certificate used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.
\n\n To import a public root key certificate\n
\nUsing this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.
\nSet the following parameters:
\n\n KeyMaterial: RootCertificatePublicKey\n
\n KeyClass: PUBLIC_KEY\n
\n KeyModesOfUse: Verify\n
\n KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE\n
\n PublicKeyCertificate: The certificate authority used to sign the root public key certificate.
\n To import a trusted public key certificate\n
\nThe root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:
\n\n KeyMaterial: TrustedCertificatePublicKey\n
\n CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
\n KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
\n PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.
\n Import main keys\n
\nAmazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to import main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). During the key import process, KDH is the user who initiates the key import and KRH is Amazon Web Services Payment Cryptography who receives the key. Before initiating TR-34 key import, you must obtain an import token by calling GetParametersForImport. This operation also returns the wrapping key certificate that KDH uses wrap key under import to generate a TR-34 wrapped key block. The import token expires after 7 days.
\nSet the following parameters:
\n\n CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.
\n ImportToken: Obtained from KRH by calling GetParametersForImport.
\n WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
\n SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.
TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.
\n\n Import working keys\n
\nAmazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import. To initiate a TR-31 key import, set the following parameters:
\n\n WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.
\n WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ExportKey\n
\nThe key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
\nFor DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
" + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether import key is enabled.
" + } + }, + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.
\nYou can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.
\nTo use this parameter, you must have TagResource permission.
Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nParameter information for root public key certificate import.
" + } + }, + "TrustedCertificatePublicKey": { + "target": "com.amazonaws.paymentcryptography#TrustedCertificatePublicKey", + "traits": { + "smithy.api#documentation": "Parameter information for trusted public key certificate import.
" + } + }, + "Tr31KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ImportTr31KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-31 standard.
" + } + }, + "Tr34KeyBlock": { + "target": "com.amazonaws.paymentcryptography#ImportTr34KeyBlock", + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-34 standard.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import.
" + } + }, + "com.amazonaws.paymentcryptography#ImportKeyOutput": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.paymentcryptography#Key", + "traits": { + "smithy.api#documentation": "The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
The TR-34 wrapped key block to import.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-31 standard.
" + } + }, + "com.amazonaws.paymentcryptography#ImportTr34KeyBlock": { + "type": "structure", + "members": { + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.
", + "smithy.api#required": {} + } + }, + "ImportToken": { + "target": "com.amazonaws.paymentcryptography#ImportTokenId", + "traits": { + "smithy.api#documentation": "The import token that initiates key import into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.
", + "smithy.api#required": {} + } + }, + "WrappedKeyBlock": { + "target": "com.amazonaws.paymentcryptography#Tr34WrappedKeyBlock", + "traits": { + "smithy.api#documentation": "The TR-34 wrapped key block to import.
", + "smithy.api#required": {} + } + }, + "KeyBlockFormat": { + "target": "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat", + "traits": { + "smithy.api#documentation": "The key block format to use during key import. The only value allowed is X9_TR34_2012.
A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for key material import using TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception, or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.paymentcryptography#Key": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key.
", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValue": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValue", + "traits": { + "smithy.api#documentation": "The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "KeyCheckValueAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm", + "traits": { + "smithy.api#documentation": "The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is enabled.
", + "smithy.api#required": {} + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The state of key that is being created or deleted.
", + "smithy.api#required": {} + } + }, + "KeyOrigin": { + "target": "com.amazonaws.paymentcryptography#KeyOrigin", + "traits": { + "smithy.api#documentation": "The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.
The date and time when the key was created.
", + "smithy.api#required": {} + } + }, + "UsageStartTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
" + } + }, + "UsageStopTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
" + } + }, + "DeletePendingTimestamp": { + "target": "com.amazonaws.paymentcryptography#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.
The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.
Metadata about an Amazon Web Services Payment Cryptography key.
" + } + }, + "com.amazonaws.paymentcryptography#KeyAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TDES_2KEY", + "name": "TDES_2KEY" + }, + { + "value": "TDES_3KEY", + "name": "TDES_3KEY" + }, + { + "value": "AES_128", + "name": "AES_128" + }, + { + "value": "AES_192", + "name": "AES_192" + }, + { + "value": "AES_256", + "name": "AES_256" + }, + { + "value": "RSA_2048", + "name": "RSA_2048" + }, + { + "value": "RSA_3072", + "name": "RSA_3072" + }, + { + "value": "RSA_4096", + "name": "RSA_4096" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 150 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 322 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$" + } + }, + "com.amazonaws.paymentcryptography#KeyAttributes": { + "type": "structure", + "members": { + "KeyUsage": { + "target": "com.amazonaws.paymentcryptography#KeyUsage", + "traits": { + "smithy.api#documentation": "The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
", + "smithy.api#required": {} + } + }, + "KeyClass": { + "target": "com.amazonaws.paymentcryptography#KeyClass", + "traits": { + "smithy.api#documentation": "The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
", + "smithy.api#required": {} + } + }, + "KeyAlgorithm": { + "target": "com.amazonaws.paymentcryptography#KeyAlgorithm", + "traits": { + "smithy.api#documentation": "The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
\nFor symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
The list of cryptographic operations that you can perform using the key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
" + } + }, + "com.amazonaws.paymentcryptography#KeyCheckValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 16 + }, + "smithy.api#pattern": "^[0-9a-fA-F]+$" + } + }, + "com.amazonaws.paymentcryptography#KeyCheckValueAlgorithm": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CMAC", + "name": "CMAC" + }, + { + "value": "ANSI_X9_24", + "name": "ANSI_X9_24" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyClass": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SYMMETRIC_KEY", + "name": "SYMMETRIC_KEY" + }, + { + "value": "ASYMMETRIC_KEY_PAIR", + "name": "ASYMMETRIC_KEY_PAIR" + }, + { + "value": "PRIVATE_KEY", + "name": "PRIVATE_KEY" + }, + { + "value": "PUBLIC_KEY", + "name": "PUBLIC_KEY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyMaterial": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 48, + "max": 16384 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.paymentcryptography#KeyMaterialType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TR34_KEY_BLOCK", + "name": "TR34_KEY_BLOCK" + }, + { + "value": "TR31_KEY_BLOCK", + "name": "TR31_KEY_BLOCK" + }, + { + "value": "ROOT_PUBLIC_KEY_CERTIFICATE", + "name": "ROOT_PUBLIC_KEY_CERTIFICATE" + }, + { + "value": "TRUSTED_PUBLIC_KEY_CERTIFICATE", + "name": "TRUSTED_PUBLIC_KEY_CERTIFICATE" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyModesOfUse": { + "type": "structure", + "members": { + "Encrypt": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
" + } + }, + "Decrypt": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
" + } + }, + "Wrap": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
" + } + }, + "Unwrap": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
" + } + }, + "Generate": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
" + } + }, + "Sign": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
" + } + }, + "Verify": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
" + } + }, + "DeriveKey": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
" + } + }, + "NoRestrictions": { + "target": "smithy.api#PrimitiveBoolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.
" + } + }, + "com.amazonaws.paymentcryptography#KeyOrigin": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the source of a key", + "smithy.api#enum": [ + { + "value": "EXTERNAL", + "name": "EXTERNAL" + }, + { + "value": "AWS_PAYMENT_CRYPTOGRAPHY", + "name": "AWS_PAYMENT_CRYPTOGRAPHY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeyState": { + "type": "string", + "traits": { + "smithy.api#documentation": "Defines the state of a key", + "smithy.api#enum": [ + { + "value": "CREATE_IN_PROGRESS", + "name": "CREATE_IN_PROGRESS" + }, + { + "value": "CREATE_COMPLETE", + "name": "CREATE_COMPLETE" + }, + { + "value": "DELETE_PENDING", + "name": "DELETE_PENDING" + }, + { + "value": "DELETE_COMPLETE", + "name": "DELETE_COMPLETE" + } + ] + } + }, + "com.amazonaws.paymentcryptography#KeySummary": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the key.
", + "smithy.api#required": {} + } + }, + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
", + "smithy.api#required": {} + } + }, + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "KeyCheckValue": { + "target": "com.amazonaws.paymentcryptography#KeyCheckValue", + "traits": { + "smithy.api#documentation": "The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or \"00\" or \"01\" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
", + "smithy.api#required": {} + } + }, + "Exportable": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is exportable. This data is immutable after the key is created.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the key is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about an Amazon Web Services Payment Cryptography key.
" + } + }, + "com.amazonaws.paymentcryptography#KeySummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#KeySummary" + } + }, + "com.amazonaws.paymentcryptography#KeyUsage": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "TR31_B0_BASE_DERIVATION_KEY", + "name": "TR31_B0_BASE_DERIVATION_KEY" + }, + { + "value": "TR31_C0_CARD_VERIFICATION_KEY", + "name": "TR31_C0_CARD_VERIFICATION_KEY" + }, + { + "value": "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY", + "name": "TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY" + }, + { + "value": "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION", + "name": "TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION" + }, + { + "value": "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS", + "name": "TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS" + }, + { + "value": "TR31_E1_EMV_MKEY_CONFIDENTIALITY", + "name": "TR31_E1_EMV_MKEY_CONFIDENTIALITY" + }, + { + "value": "TR31_E2_EMV_MKEY_INTEGRITY", + "name": "TR31_E2_EMV_MKEY_INTEGRITY" + }, + { + "value": "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS", + "name": "TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS" + }, + { + "value": "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION", + "name": "TR31_E5_EMV_MKEY_CARD_PERSONALIZATION" + }, + { + "value": "TR31_E6_EMV_MKEY_OTHER", + "name": "TR31_E6_EMV_MKEY_OTHER" + }, + { + "value": "TR31_K0_KEY_ENCRYPTION_KEY", + "name": "TR31_K0_KEY_ENCRYPTION_KEY" + }, + { + "value": "TR31_K1_KEY_BLOCK_PROTECTION_KEY", + "name": "TR31_K1_KEY_BLOCK_PROTECTION_KEY" + }, + { + "value": "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT", + "name": "TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT" + }, + { + "value": "TR31_M3_ISO_9797_3_MAC_KEY", + "name": "TR31_M3_ISO_9797_3_MAC_KEY" + }, + { + "value": "TR31_M6_ISO_9797_5_CMAC_KEY", + "name": "TR31_M6_ISO_9797_5_CMAC_KEY" + }, + { + "value": "TR31_M7_HMAC_KEY", + "name": "TR31_M7_HMAC_KEY" + }, + { + "value": "TR31_P0_PIN_ENCRYPTION_KEY", + "name": "TR31_P0_PIN_ENCRYPTION_KEY" + }, + { + "value": "TR31_P1_PIN_GENERATION_KEY", + "name": "TR31_P1_PIN_GENERATION_KEY" + }, + { + "value": "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", + "name": "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE" + }, + { + "value": "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", + "name": "TR31_V1_IBM3624_PIN_VERIFICATION_KEY" + }, + { + "value": "TR31_V2_VISA_PIN_VERIFICATION_KEY", + "name": "TR31_V2_VISA_PIN_VERIFICATION_KEY" + }, + { + "value": "TR31_K2_TR34_ASYMMETRIC_KEY", + "name": "TR31_K2_TR34_ASYMMETRIC_KEY" + } + ] + } + }, + "com.amazonaws.paymentcryptography#ListAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListAliasesInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListAliasesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
\nThis is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value.\n Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n UpdateAlias\n
\nUse this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
\nThis value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListAliasesOutput": { + "type": "structure", + "members": { + "Aliases": { + "target": "com.amazonaws.paymentcryptography#Aliases", + "traits": { + "smithy.api#documentation": "The list of aliases. Each alias describes the KeyArn contained within.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListKeysInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListKeysOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.
\nThis is a paginated operation, which means that each response might contain only a subset of all the keys.\n When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Keys" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeysInput": { + "type": "structure", + "members": { + "KeyState": { + "target": "com.amazonaws.paymentcryptography#KeyState", + "traits": { + "smithy.api#documentation": "The key state of the keys you want to list.
" + } + }, + "NextToken": { + "target": "com.amazonaws.paymentcryptography#NextToken", + "traits": { + "smithy.api#documentation": "Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListKeysOutput": { + "type": "structure", + "members": { + "Keys": { + "target": "com.amazonaws.paymentcryptography#KeySummaryList", + "traits": { + "smithy.api#documentation": "The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.paymentcryptography#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Lists the tags for an Amazon Web Services resource.
\nThis is a paginated operation, which means that each response might contain only a subset of all the tags.\n When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags.\n When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n TagResource\n
\n\n UntagResource\n
\nThe KeyARN of the key whose tags you are getting.
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.
Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.paymentcryptography#Tags", + "traits": { + "smithy.api#documentation": "The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
The token for the next set of results, or an empty or null value if there are no more results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.paymentcryptography#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.paymentcryptography#PaymentCryptographyControlPlane": { + "type": "service", + "version": "2021-09-14", + "operations": [ + { + "target": "com.amazonaws.paymentcryptography#CreateAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#CreateKey" + }, + { + "target": "com.amazonaws.paymentcryptography#DeleteAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#DeleteKey" + }, + { + "target": "com.amazonaws.paymentcryptography#ExportKey" + }, + { + "target": "com.amazonaws.paymentcryptography#GetAlias" + }, + { + "target": "com.amazonaws.paymentcryptography#GetKey" + }, + { + "target": "com.amazonaws.paymentcryptography#GetParametersForExport" + }, + { + "target": "com.amazonaws.paymentcryptography#GetParametersForImport" + }, + { + "target": "com.amazonaws.paymentcryptography#GetPublicKeyCertificate" + }, + { + "target": "com.amazonaws.paymentcryptography#ImportKey" + }, + { + "target": "com.amazonaws.paymentcryptography#ListAliases" + }, + { + "target": "com.amazonaws.paymentcryptography#ListKeys" + }, + { + "target": "com.amazonaws.paymentcryptography#ListTagsForResource" + }, + { + "target": "com.amazonaws.paymentcryptography#RestoreKey" + }, + { + "target": "com.amazonaws.paymentcryptography#StartKeyUsage" + }, + { + "target": "com.amazonaws.paymentcryptography#StopKeyUsage" + }, + { + "target": "com.amazonaws.paymentcryptography#TagResource" + }, + { + "target": "com.amazonaws.paymentcryptography#UntagResource" + }, + { + "target": "com.amazonaws.paymentcryptography#UpdateAlias" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Payment Cryptography", + "arnNamespace": "payment-cryptography", + "endpointPrefix": "controlplane.payment-cryptography" + }, + "aws.auth#sigv4": { + "name": "payment-cryptography" + }, + "aws.protocols#awsJson1_0": {}, + "smithy.api#cors": {}, + "smithy.api#documentation": "You use the Amazon Web Services Payment Cryptography Control Plane to manage the encryption keys you use for payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.\n
\nTo use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations.
\nAll Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.
\nAmazon Web Services Payment Cryptography supports CloudTrail, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
", + "smithy.api#title": "Payment Cryptography Control Plane", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://controlplane.payment-cryptography.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-gov-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-gov-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": true, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "UseFIPS": false, + "Region": "cn-north-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-iso-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-east-1.api.aws" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-east-1.amazonaws.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": true, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://controlplane.payment-cryptography.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-isob-east-1", + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "UseFIPS": true, + "Region": "us-east-1", + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "UseFIPS": false, + "Region": "us-east-1", + "UseDualStack": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.paymentcryptography#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 70, + "max": 150 + }, + "smithy.api#pattern": "^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" + } + }, + "com.amazonaws.paymentcryptography#ResourceNotFoundException": { + "type": "structure", + "members": { + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The string for the exception.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid resource error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.paymentcryptography#RestoreKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#RestoreKeyInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#RestoreKeyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.
During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted.\n After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.
\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\n\n StopKeyUsage\n
\nThe KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the root public key is imported.
", + "smithy.api#required": {} + } + }, + "PublicKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Parameter information for root public key certificate import.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for root public key certificate import.
" + } + }, + "com.amazonaws.paymentcryptography#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This request would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.paymentcryptography#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The service cannot complete the request.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.paymentcryptography#StartKeyUsage": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#StartKeyUsageInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#StartKeyUsageOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n StopKeyUsage\n
\nThe KeyArn of the key.
The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
\nYou can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n DeleteKey\n
\n\n StartKeyUsage\n
\nThe KeyArn of the key.
The KeyARN of the key.
The key of the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.paymentcryptography#TagValue", + "traits": { + "smithy.api#documentation": "The value of the tag.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains information about a tag.
" + } + }, + "com.amazonaws.paymentcryptography#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.paymentcryptography#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.paymentcryptography#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.paymentcryptography#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Adds or edits tags on an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\nEach tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n UntagResource\n
\nThe KeyARN of the key whose tags are being updated.
One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.
\nDon't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nTo use this parameter, you must have TagResource permission in an IAM policy.
\nDon't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
\nThe request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.paymentcryptography#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.paymentcryptography#Tr31WrappedKeyBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 56, + "max": 9984 + }, + "smithy.api#pattern": "^[0-9A-Z]+$" + } + }, + "com.amazonaws.paymentcryptography#Tr34KeyBlockFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "X9_TR34_2012", + "name": "X9_TR34_2012" + } + ] + } + }, + "com.amazonaws.paymentcryptography#Tr34WrappedKeyBlock": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 4096 + }, + "smithy.api#pattern": "^[0-9A-F]+$" + } + }, + "com.amazonaws.paymentcryptography#TrustedCertificatePublicKey": { + "type": "structure", + "members": { + "KeyAttributes": { + "target": "com.amazonaws.paymentcryptography#KeyAttributes", + "traits": { + "smithy.api#documentation": "The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after a trusted public key is imported.
", + "smithy.api#required": {} + } + }, + "PublicKeyCertificate": { + "target": "com.amazonaws.paymentcryptography#CertificateType", + "traits": { + "smithy.api#documentation": "Parameter information for trusted public key certificate import.
", + "smithy.api#required": {} + } + }, + "CertificateAuthorityPublicKeyIdentifier": { + "target": "com.amazonaws.paymentcryptography#KeyArnOrKeyAliasType", + "traits": { + "smithy.api#documentation": "The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
Parameter information for trusted public key certificate import.
" + } + }, + "com.amazonaws.paymentcryptography#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Deletes a tag from an Amazon Web Services Payment Cryptography key.
\nTagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\nThe KeyARN of the key whose tags are being removed.
One or more tag keys. Don't include the tag values.
\nIf the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.paymentcryptography#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#UpdateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.paymentcryptography#UpdateAliasInput" + }, + "output": { + "target": "com.amazonaws.paymentcryptography#UpdateAliasOutput" + }, + "errors": [ + { + "target": "com.amazonaws.paymentcryptography#AccessDeniedException" + }, + { + "target": "com.amazonaws.paymentcryptography#ConflictException" + }, + { + "target": "com.amazonaws.paymentcryptography#InternalServerException" + }, + { + "target": "com.amazonaws.paymentcryptography#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.paymentcryptography#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.paymentcryptography#ThrottlingException" + }, + { + "target": "com.amazonaws.paymentcryptography#ValidationException" + } + ], + "traits": { + "aws.api#controlPlane": {}, + "smithy.api#documentation": "Associates an existing Amazon Web Services Payment Cryptography alias with a different key. Each alias is associated with only one Amazon Web Services Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the Amazon Web Services Payment Cryptography key must be in the same Amazon Web Services account and Amazon Web Services Region
\n\n Cross-account use: This operation can't be used across different Amazon Web Services accounts.
\n\n Related operations:\n
\n\n CreateAlias\n
\n\n DeleteAlias\n
\n\n GetAlias\n
\n\n ListAliases\n
\nThe alias whose associated key is changing.
", + "smithy.api#required": {} + } + }, + "KeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The KeyARN for the key that you are updating or removing from the alias.
The alias name.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.paymentcryptography#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to an invalid request error.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.paymentcryptography#WrappedKey": { + "type": "structure", + "members": { + "WrappingKeyArn": { + "target": "com.amazonaws.paymentcryptography#KeyArn", + "traits": { + "smithy.api#documentation": "The KeyARN of the wrapped key.
The key block format of a wrapped key.
", + "smithy.api#required": {} + } + }, + "KeyMaterial": { + "target": "com.amazonaws.paymentcryptography#KeyMaterial", + "traits": { + "smithy.api#documentation": "Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter information for generating a wrapped key using TR-31 or TR-34 standard.
" + } + }, + "com.amazonaws.paymentcryptography#WrappedKeyMaterialFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "KEY_CRYPTOGRAM", + "name": "KEY_CRYPTOGRAM" + }, + { + "value": "TR31_KEY_BLOCK", + "name": "TR31_KEY_BLOCK" + }, + { + "value": "TR34_KEY_BLOCK", + "name": "TR34_KEY_BLOCK" + } + ] + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json b/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json index a04c884c8dc..2b134cfddd0 100644 --- a/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json +++ b/codegen/sdk-codegen/aws-models/pricing.2017-10-15.json @@ -1,33 +1,5 @@ { "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, "shapes": { "com.amazonaws.pricing#AWSPriceListService": { "type": "service", @@ -54,14 +26,14 @@ "sdkId": "Pricing", "arnNamespace": "pricing", "cloudFormationName": "Pricing", - "cloudTrailEventSource": "pricing.amazonaws.com", + "cloudTrailEventSource": "pricelist.amazonaws.com", "endpointPrefix": "api.pricing" }, "aws.auth#sigv4": { "name": "pricing" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Price List API is a centralized and convenient way to\n programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List\n uses standardized product attributes such as Location, Storage\n Class, and Operating System, and provides prices at the SKU\n level. You can use the Amazon Web Services Price List to build cost control and scenario planning tools, reconcile\n billing data, forecast future spend for budgeting purposes, and provide cost benefit\n analysis that compare your internal workloads with Amazon Web Services.
Use GetServices without a service code to retrieve the service codes for all AWS services, then \n GetServices with a service code to retrieve the attribute names for \n that service. After you have the service code and attribute names, you can use GetAttributeValues\n to see what values are available for an attribute. With the service code and an attribute name and value, \n you can use GetProducts to find specific products that you're interested in, such as \n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.
Service Endpoint
\nAmazon Web Services Price List service API provides the following two endpoints:
\nhttps://api.pricing.us-east-1.amazonaws.com
\nhttps://api.pricing.ap-south-1.amazonaws.com
\nThe Amazon Web Services Price List API is a centralized and convenient way to programmatically\n query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location,\n Storage Class, and Operating System, and provides prices at\n the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
\nReconcile billing data
\nForecast future spend for budgeting purposes
\nProvide cost benefit analysis that compare your internal workloads with Amazon Web Services
\nUse GetServices without a service code to retrieve the service codes for\n all Amazon Web Services, then GetServices with a service code to\n retrieve the attribute names for that service. After you have the service code and\n attribute names, you can use GetAttributeValues to see what values are\n available for an attribute. With the service code and an attribute name and value, you can\n use GetProducts to find specific products that you're interested in, such as\n an AmazonEC2 instance, with a Provisioned IOPS\n volumeType.
You can use the following endpoints for the Amazon Web Services Price List API:
\nhttps://api.pricing.us-east-1.amazonaws.com
\nhttps://api.pricing.ap-south-1.amazonaws.com
\nThe maximum number of results to return in the response.\n
" } } @@ -1393,6 +1366,7 @@ "com.amazonaws.pricing#MaxResults": { "type": "integer", "traits": { + "smithy.api#default": 100, "smithy.api#range": { "min": 1, "max": 100 @@ -1451,7 +1425,7 @@ "min": 18, "max": 2048 }, - "smithy.api#pattern": "^arn:.+:pricing::.*:price-list/.{1,255}/.{1,32}/[A-Z]{3}/[0-9]{14}/[^/]*$" + "smithy.api#pattern": "^arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9_/.-]{1,1023}$" } }, "com.amazonaws.pricing#PriceListJsonItems": { @@ -1524,4 +1498,4 @@ "type": "string" } } -} +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index 2bc0086bf0e..9d7ab56ef4d 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -1847,13 +1847,13 @@ "CredentialPair": { "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair", "traits": { - "smithy.api#documentation": "A username and password credential pair to be used to create the imported data source. Leave this field blank if you are using an Secrets Manager Secret to provide credentials.
" + "smithy.api#documentation": "A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
" } }, "SecretArn": { "target": "com.amazonaws.quicksight#SecretArn", "traits": { - "smithy.api#documentation": "The ARN of the Secrets Manager Secret to be used to create the imported data source leave this field blank if you aren't using a Secret in place of a credential pair.
" + "smithy.api#documentation": "The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
" } } }, @@ -2017,7 +2017,7 @@ "StartAfterDateTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "An override for the StartAfterDateTime of a RefreshSchedule to ensure that the StartAfterDateTime is set to a time that takes place in the future.
An override for the StartAfterDateTime of a RefreshSchedule. Make\n sure that the StartAfterDateTime is set to a time that takes\n place in the future.
An optional structure that configures resource ID overrides for the import job
" + "smithy.api#documentation": "An optional structure that configures resource ID overrides for the import job.
" } }, "com.amazonaws.quicksight#AssetBundleImportJobStatus": { @@ -2194,19 +2194,19 @@ "SubnetIds": { "target": "com.amazonaws.quicksight#SubnetIdList", "traits": { - "smithy.api#documentation": "A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or region.
" + "smithy.api#documentation": "A list of new subnet IDs for the VPC connection you are importing. This field is\n required if you are importing the VPC connection from another Amazon Web Services account or Region.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.quicksight#SecurityGroupIdList", "traits": { - "smithy.api#documentation": "A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or region.
" + "smithy.api#documentation": "A new security group ID for the VPC connection you are importing. This field is required\n if you are importing the VPC connection from another Amazon Web Services account or Region.
" } }, "DnsResolvers": { "target": "com.amazonaws.quicksight#DnsResolverList", "traits": { - "smithy.api#documentation": "An optional override of dns resolvers to be used by the VPC connection.
" + "smithy.api#documentation": "An optional override of DNS resolvers to be used by the VPC connection.
" } }, "RoleArn": { @@ -2238,13 +2238,13 @@ "Body": { "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", "traits": { - "smithy.api#documentation": "The bytes of the Base64 encoded asset bundle import zip file. This file can't exceed 20MB.
\nIf you are calling the APIs from the Amazon Web Services Java, JavaScript, Python, or PHP SDKs, the SDK encodes Base64 automatically to allow the direct setting of the zip file's bytes. If you are using a SDK of a different language or are receiving related errors, try to Base64 encode your data.
" + "smithy.api#documentation": "The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.
\nIf you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.
" } }, "S3Uri": { "target": "com.amazonaws.quicksight#S3Uri", "traits": { - "smithy.api#documentation": "The Amazon S3 uri for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20MB.
" + "smithy.api#documentation": "The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.
" } } }, @@ -2258,18 +2258,18 @@ "Body": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
The Amazon S3 uri that you provided at the start of the import job.
" + "smithy.api#documentation": "The Amazon S3 URI that you provided at the start of the import job.
" } } }, "traits": { - "smithy.api#documentation": "A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri depending on how the StartAssetBundleImportJobRequest is configured.
A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.
Indicates tha status of a job through its queueing and execution.
\nPoll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.
Indicates the status of a job through its queuing and execution.
\nPoll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.
Indicates tha status of a job through its queueing and execution.
\nPoll this DescribeAssetBundleImport API until JobStatus returns one of the following values.
\n SUCCESSFUL\n
\n FAILED\n
\n FAILED_ROLLBACK_COMPLETED\n
\n FAILED_ROLLBACK_ERROR\n
Indicates the status of a job through its queuing and execution.
\nPoll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
\n SUCCESSFUL\n
\n FAILED\n
\n FAILED_ROLLBACK_COMPLETED\n
\n FAILED_ROLLBACK_ERROR\n
The scope of the cell for conditional formatting.
" } + }, + "Scopes": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList", + "traits": { + "smithy.api#documentation": "A list of cell scopes for conditional formatting.
" + } } }, "traits": { @@ -32203,6 +32209,18 @@ "smithy.api#documentation": "The scope of the cell for conditional formatting.
" } }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole": { "type": "enum", "members": { @@ -32315,6 +32333,70 @@ } } }, + "com.amazonaws.quicksight#PivotTableFieldCollapseState": { + "type": "enum", + "members": { + "COLLAPSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLAPSED" + } + }, + "EXPANDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPANDED" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget", + "traits": { + "smithy.api#documentation": "A tagged-union object that sets the collapse state.
", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseState", + "traits": { + "smithy.api#documentation": "The state of the field target of a pivot table. Choose one of the following options:
\n\n COLLAPSED\n
\n EXPANDED\n
The collapse state options for the pivot table field options.
" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The field ID of the pivot table that the collapse state needs to be set to.
" + } + }, + "FieldDataPathValues": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "The data path of the pivot table's header. Used to set the collapse state.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target of a pivot table field collapse state.
" + } + }, "com.amazonaws.quicksight#PivotTableFieldOption": { "type": "structure", "members": { @@ -32368,6 +32450,12 @@ "traits": { "smithy.api#documentation": "The data path options for the pivot table field options.
" } + }, + "CollapseStateOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList", + "traits": { + "smithy.api#documentation": "The collapse state options for the pivot table field options.
" + } } }, "traits": { @@ -34546,6 +34634,29 @@ "smithy.api#documentation": "The configured style settings of a radar chart.
" } }, + "com.amazonaws.quicksight#RadarChartAxesRangeScale": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } + }, "com.amazonaws.quicksight#RadarChartCategoryFieldList": { "type": "list", "member": { @@ -34656,6 +34767,12 @@ "traits": { "smithy.api#documentation": "The legend display setup of the visual.
" } + }, + "AxesRangeScale": { + "target": "com.amazonaws.quicksight#RadarChartAxesRangeScale", + "traits": { + "smithy.api#documentation": "The axis behavior options of a radar chart.
" + } } }, "traits": { @@ -39141,7 +39258,7 @@ "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and dataource resource that is a dependency of the dashboard is also exported.
A Boolean that determines whether all dependencies of each resource ARN are recursively\n exported with the job. For example, say you provided a Dashboard ARN to the\n ResourceArns parameter. If you set IncludeAllDependencies to\n TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also\n exported.
The failure action for the import job.
\nIf you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly leaving the Amazon QuickSight account in an inconsistent state.
The failure action for the import job.
\nIf you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
The Amazon Resource Name (ARN) for the certificate associated with the custom domain.
" + } + }, + "CustomDomainCertificateExpiryDate": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "The expiration date for the certificate.
" + } + }, + "CertificateAssociations": { + "target": "com.amazonaws.redshift#CertificateAssociationList", + "traits": { + "smithy.api#documentation": "A list of all associated clusters and domain names tied to a specific certificate.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the custom domain name association.
" + } + }, + "com.amazonaws.redshift#AssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#Association", + "traits": { + "smithy.api#xmlName": "Association" + } + } + }, "com.amazonaws.redshift#AttributeList": { "type": "list", "member": { @@ -620,6 +655,9 @@ "ClusterSecurityGroup": { "target": "com.amazonaws.redshift#ClusterSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#AuthorizeDataShare": { @@ -767,7 +805,7 @@ "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user or role has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" + "smithy.api#documentation": "The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" } }, "AccountWithRestoreAccess": { @@ -788,6 +826,9 @@ "Snapshot": { "target": "com.amazonaws.redshift#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#AvailabilityZone": { @@ -866,6 +907,9 @@ "smithy.api#documentation": "A list of any errors returned.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#BatchDeleteRequestSizeExceededFault": { @@ -1046,6 +1090,35 @@ } } }, + "com.amazonaws.redshift#CertificateAssociation": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The custom domain name for the certificate association.
" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The cluster identifier for the certificate association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A cluster ID and custom domain name tied to a specific certificate. These are typically \n returned in a list.
" + } + }, + "com.amazonaws.redshift#CertificateAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.redshift#CertificateAssociation", + "traits": { + "smithy.api#xmlName": "CertificateAssociation" + } + } + }, "com.amazonaws.redshift#Cluster": { "type": "structure", "members": { @@ -1367,6 +1440,24 @@ "traits": { "smithy.api#documentation": "The status of the reserved-node exchange request. Statuses include in-progress and requested.
" } + }, + "CustomDomainName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the cluster.
" + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the custom domain name.
" + } + }, + "CustomDomainCertificateExpiryDate": { + "target": "com.amazonaws.redshift#TStamp", + "traits": { + "smithy.api#documentation": "The expiration date for the certificate associated with the custom domain name.
" + } } }, "traits": { @@ -2353,7 +2444,7 @@ "SourceSnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the cluster the source snapshot was created from. This parameter\n is required if your IAM user or role has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
\nConstraints:
\nMust be the identifier for a valid cluster.
\nThe identifier of the cluster the source snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
\nConstraints:
\nMust be the identifier for a valid cluster.
\nThe content of the authentication profile in JSON format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateCluster": { @@ -2570,14 +2667,14 @@ "MasterUsername": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The user name associated with the admin user for the cluster that is being\n created.
\nConstraints:
\nMust be 1 - 128 alphanumeric characters or hyphens. The user name can't be\n PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
\nThe first character must be a letter.
\nMust not contain a colon (:) or a slash (/).
\nCannot be a reserved word. A list of reserved words can be found in Reserved\n Words in the Amazon Redshift Database Developer Guide.
\nThe user name associated with the admin user account for the cluster that is being\n created.
\nConstraints:
\nMust be 1 - 128 alphanumeric characters or hyphens. The user name can't be\n PUBLIC.
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
\nThe first character must be a letter.
\nMust not contain a colon (:) or a slash (/).
\nCannot be a reserved word. A list of reserved words can be found in Reserved\n Words in the Amazon Redshift Database Developer Guide.
\nThe password associated with the admin user for the cluster that is being\n created.
\nConstraints:
\nMust be between 8 and 64 characters in length.
\nMust contain at least one uppercase letter.
\nMust contain at least one lowercase letter.
\nMust contain one number.
\nCan be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.
The password associated with the admin user account for the cluster that is being\n created.
\nConstraints:
\nMust be between 8 and 64 characters in length.
\nMust contain at least one uppercase letter.
\nMust contain at least one lowercase letter.
\nMust contain one number.
\nCan be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.
Used to create a custom domain name for a cluster. Properties include the custom domain name, the \n cluster the custom domain is associated with, and the certificate Amazon Resource Name (ARN).
" + } + }, + "com.amazonaws.redshift#CreateCustomDomainAssociationMessage": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#documentation": "The custom domain name for a custom domain association.
", + "smithy.api#required": {} + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the custom domain name association.
", + "smithy.api#required": {} + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The cluster identifier that the custom domain is associated with.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.redshift#CreateCustomDomainAssociationResult": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#documentation": "The custom domain name for the association result.
" + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the certificate associated with the custom domain name.
" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the cluster that the custom domain is associated with.
" + } + }, + "CustomDomainCertExpiryTime": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The expiration time for the certificate for the custom domain.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateEndpointAccess": { @@ -3243,6 +3436,9 @@ "EventSubscription": { "target": "com.amazonaws.redshift#EventSubscription" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateHsmClientCertificate": { @@ -3298,6 +3494,9 @@ "HsmClientCertificate": { "target": "com.amazonaws.redshift#HsmClientCertificate" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateHsmConfiguration": { @@ -3388,6 +3587,9 @@ "HsmConfiguration": { "target": "com.amazonaws.redshift#HsmConfiguration" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateScheduledAction": { @@ -3544,6 +3746,9 @@ "SnapshotCopyGrant": { "target": "com.amazonaws.redshift#SnapshotCopyGrant" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#CreateSnapshotSchedule": { @@ -3754,6 +3959,77 @@ } } }, + "com.amazonaws.redshift#CustomCnameAssociationFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomCnameAssociationFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "An error occurred when an attempt was made to change the custom domain association.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.redshift#CustomDomainAssociationNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.redshift#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDomainAssociationNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "An error occurred. The custom domain name couldn't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.redshift#CustomDomainAssociationsMessage": { + "type": "structure", + "members": { + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The marker for the custom domain association.
" + } + }, + "Associations": { + "target": "com.amazonaws.redshift#AssociationList", + "traits": { + "smithy.api#documentation": "The associations for the custom domain.
" + } + } + } + }, + "com.amazonaws.redshift#CustomDomainCertificateArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w+=/,.@-]+:acm:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*$" + } + }, + "com.amazonaws.redshift#CustomDomainNameString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 253 + }, + "smithy.api#pattern": "^((?!-)[A-Za-z0-9-]{1,63}(?The name of the authentication profile that was deleted." } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#DeleteCluster": { @@ -4251,6 +4530,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#DeleteClusterSecurityGroup": { @@ -4321,7 +4603,7 @@ "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The unique identifier of the cluster the snapshot was created from. This parameter\n is required if your IAM user or role has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
\nConstraints: Must be the name of valid cluster.
" + "smithy.api#documentation": "The unique identifier of the cluster the snapshot was created from. This parameter\n is required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
\nConstraints: Must be the name of valid cluster.
" } } }, @@ -4344,6 +4626,9 @@ "Snapshot": { "target": "com.amazonaws.redshift#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#DeleteClusterSubnetGroup": { @@ -4384,6 +4669,41 @@ "smithy.api#documentation": "" } }, + "com.amazonaws.redshift#DeleteCustomDomainAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DeleteCustomDomainAssociationMessage" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#ClusterNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#CustomCnameAssociationFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Contains information about deleting a custom domain association for a cluster.
" + } + }, + "com.amazonaws.redshift#DeleteCustomDomainAssociationMessage": { + "type": "structure", + "members": { + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the cluster to delete a custom domain association for.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.redshift#DeleteEndpointAccess": { "type": "operation", "input": { @@ -4823,6 +5143,9 @@ "smithy.api#documentation": "The list of authentication profiles.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#DescribeClusterDbRevisions": { @@ -5169,7 +5492,7 @@ "MaxRecords": { "target": "com.amazonaws.redshift#IntegerOptional", "traits": { - "smithy.api#documentation": "The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.
Default: 100\n
Constraints: minimum 20, maximum 500.
" + "smithy.api#documentation": "The maximum number of response records to return in each call. If the number of\n remaining response records exceeds the specified MaxRecords value, a value\n is returned in a marker field of the response. You can retrieve the next\n set of records by retrying the command with the returned marker value.
Default: 100\n
Constraints: minimum 20, maximum 100.
" } }, "Marker": { @@ -5532,6 +5855,61 @@ "smithy.api#documentation": "" } }, + "com.amazonaws.redshift#DescribeCustomDomainAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.redshift#DescribeCustomDomainAssociationsMessage" + }, + "output": { + "target": "com.amazonaws.redshift#CustomDomainAssociationsMessage" + }, + "errors": [ + { + "target": "com.amazonaws.redshift#CustomDomainAssociationNotFoundFault" + }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + } + ], + "traits": { + "smithy.api#documentation": "Contains information for custom domain associations for a cluster.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "Associations", + "pageSize": "MaxRecords" + } + } + }, + "com.amazonaws.redshift#DescribeCustomDomainAssociationsMessage": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#documentation": "The custom domain name for the custom domain association.
" + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the custom domain association.
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.redshift#IntegerOptional", + "traits": { + "smithy.api#documentation": "The maximum records setting for the associated custom domain.
" + } + }, + "Marker": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The marker for the custom domain association.
" + } + } + } + }, "com.amazonaws.redshift#DescribeDataShares": { "type": "operation", "input": { @@ -5622,6 +6000,9 @@ "smithy.api#documentation": "An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForConsumer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response\n records. When the results of a DescribeDataSharesForProducer request\n exceed the value specified in MaxRecords, Amazon Web Services returns a value in the\n Marker field of the response. You can retrieve the next set of response\n records by providing the returned marker value in the Marker parameter and\n retrying the request.
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
The unique identifier of the cluster that contains the database for which you are\n requesting credentials. This parameter is case sensitive.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the cluster that contains the database for which you are\n requesting credentials. This parameter is case sensitive.
" } }, "DurationSeconds": { @@ -8143,6 +8538,12 @@ "traits": { "smithy.api#documentation": "A list of the names of existing database groups that the user named in\n DbUser will join for the current session, in addition to any group\n memberships for an existing user. If not specified, a new user is added only to\n PUBLIC.
Database group name constraints
\nMust be 1 to 64 alphanumeric characters or hyphens
\nMust contain only lowercase letters, numbers, underscore, plus sign, period\n (dot), at symbol (@), or hyphen.
\nFirst character must be a letter.
\nMust not contain a colon ( : ) or slash ( / ).
\nCannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon\n Redshift Database Developer Guide.
\nThe custom domain name for the cluster credentials.
" + } } }, "traits": { @@ -8181,8 +8582,7 @@ "ClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The unique identifier of the cluster that contains the database for which you are\n requesting credentials.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique identifier of the cluster that contains the database for which you are\n requesting credentials.
" } }, "DurationSeconds": { @@ -8190,6 +8590,12 @@ "traits": { "smithy.api#documentation": "The number of seconds until the returned temporary password expires.
\nRange: 900-3600. Default: 900.
" } + }, + "CustomDomainName": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The custom domain name for the IAM message cluster credentials.
" + } } } }, @@ -9529,6 +9935,9 @@ "smithy.api#documentation": "The updated content of the authentication profile in JSON format.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyCluster": { @@ -9552,6 +9961,9 @@ { "target": "com.amazonaws.redshift#ClusterSecurityGroupNotFoundFault" }, + { + "target": "com.amazonaws.redshift#CustomCnameAssociationFault" + }, { "target": "com.amazonaws.redshift#DependentServiceRequestThrottlingFault" }, @@ -9594,6 +10006,9 @@ { "target": "com.amazonaws.redshift#UnauthorizedOperation" }, + { + "target": "com.amazonaws.redshift#UnsupportedOperationFault" + }, { "target": "com.amazonaws.redshift#UnsupportedOptionFault" } @@ -9650,6 +10065,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyClusterIamRoles": { @@ -9711,6 +10129,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyClusterMaintenance": { @@ -9781,6 +10202,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyClusterMessage": { @@ -9826,7 +10250,7 @@ "MasterUserPassword": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The new password for the cluster admin user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
Operations never return the password, so this operation provides a way to\n regain access to the admin user for a cluster if the password is\n lost.
\nDefault: Uses existing setting.
\nConstraints:
\nMust be between 8 and 64 characters in length.
\nMust contain at least one uppercase letter.
\nMust contain at least one lowercase letter.
\nMust contain one number.
\nCan be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.
The new password for the cluster admin user. This change is asynchronously applied\n as soon as possible. Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.
Operations never return the password, so this operation provides a way to\n regain access to the admin user account for a cluster if the password is\n lost.
\nDefault: Uses existing setting.
\nConstraints:
\nMust be between 8 and 64 characters in length.
\nMust contain at least one uppercase letter.
\nMust contain at least one lowercase letter.
\nMust contain one number.
\nCan be any printable ASCII character (ASCII code 33-126) except '\n (single quote), \" (double quote), \\, /, or @.
Contains information for changing a custom domain association.
" + } + }, + "com.amazonaws.redshift#ModifyCustomDomainAssociationMessage": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#documentation": "The custom domain name for a changed custom domain association.
" + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) for the changed custom domain association.
" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the cluster to change a custom domain association for.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.redshift#ModifyCustomDomainAssociationResult": { + "type": "structure", + "members": { + "CustomDomainName": { + "target": "com.amazonaws.redshift#CustomDomainNameString", + "traits": { + "smithy.api#documentation": "The custom domain name associated with the result for the changed custom domain association.
" + } + }, + "CustomDomainCertificateArn": { + "target": "com.amazonaws.redshift#CustomDomainCertificateArnString", + "traits": { + "smithy.api#documentation": "The certificate Amazon Resource Name (ARN) associated with the result for the changed custom domain association.
" + } + }, + "ClusterIdentifier": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of the cluster associated with the result for the changed custom domain association.
" + } + }, + "CustomDomainCertExpiryTime": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The certificate expiration time associated with the result for the changed custom domain association.
" + } + } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyEndpointAccess": { @@ -10311,6 +10823,9 @@ "EventSubscription": { "target": "com.amazonaws.redshift#EventSubscription" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifyScheduledAction": { @@ -10461,6 +10976,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ModifySnapshotSchedule": { @@ -11197,6 +11715,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#PendingActionsList": { @@ -11332,6 +11853,9 @@ "ReservedNode": { "target": "com.amazonaws.redshift#ReservedNode" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RebootCluster": { @@ -11375,6 +11899,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RecurringCharge": { @@ -11462,6 +11989,9 @@ { "target": "com.amazonaws.redshift#CreateClusterSubnetGroup" }, + { + "target": "com.amazonaws.redshift#CreateCustomDomainAssociation" + }, { "target": "com.amazonaws.redshift#CreateEndpointAccess" }, @@ -11510,6 +12040,9 @@ { "target": "com.amazonaws.redshift#DeleteClusterSubnetGroup" }, + { + "target": "com.amazonaws.redshift#DeleteCustomDomainAssociation" + }, { "target": "com.amazonaws.redshift#DeleteEndpointAccess" }, @@ -11573,6 +12106,9 @@ { "target": "com.amazonaws.redshift#DescribeClusterVersions" }, + { + "target": "com.amazonaws.redshift#DescribeCustomDomainAssociations" + }, { "target": "com.amazonaws.redshift#DescribeDataShares" }, @@ -11708,6 +12244,9 @@ { "target": "com.amazonaws.redshift#ModifyClusterSubnetGroup" }, + { + "target": "com.amazonaws.redshift#ModifyCustomDomainAssociation" + }, { "target": "com.amazonaws.redshift#ModifyEndpointAccess" }, @@ -13540,6 +14079,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ResizeInfo": { @@ -13845,7 +14387,7 @@ "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The name of the cluster the source snapshot was created from. This parameter is\n required if your IAM user or role has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" + "smithy.api#documentation": "The name of the cluster the source snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" } }, "Port": { @@ -14033,6 +14575,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RestoreStatus": { @@ -14192,6 +14737,9 @@ "TableRestoreStatus": { "target": "com.amazonaws.redshift#TableRestoreStatus" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#ResumeCluster": { @@ -14238,6 +14786,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RevisionTarget": { @@ -14337,6 +14888,9 @@ "ClusterSecurityGroup": { "target": "com.amazonaws.redshift#ClusterSecurityGroup" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RevokeEndpointAccess": { @@ -14448,7 +15002,7 @@ "SnapshotClusterIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user or role has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" + "smithy.api#documentation": "The identifier of the cluster the snapshot was created from. This parameter is\n required if your IAM user has a policy containing a snapshot resource element that\n specifies anything other than * for the cluster name.
" } }, "AccountWithRestoreAccess": { @@ -14469,6 +15023,9 @@ "Snapshot": { "target": "com.amazonaws.redshift#Snapshot" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#RotateEncryptionKey": { @@ -14515,6 +15072,9 @@ "Cluster": { "target": "com.amazonaws.redshift#Cluster" } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.redshift#SNSInvalidTopicFault": { diff --git a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json index d431ec27489..d42a1cdaece 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk-codegen/aws-models/rekognition.2016-06-27.json @@ -87,6 +87,182 @@ "target": "com.amazonaws.rekognition#Asset" } }, + "com.amazonaws.rekognition#AssociateFaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#AssociateFacesRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#AssociateFacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#ConflictException" + }, + { + "target": "com.amazonaws.rekognition#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Associates one or more faces with an existing UserID. Takes an array of\n FaceIds. Each FaceId that are present in the FaceIds\n list is associated with the provided UserID. The maximum number of total FaceIds\n per UserID is 100.
The UserMatchThreshold parameter specifies the minimum user match confidence\n required for the face to be associated with a UserID that has at least one FaceID\n already associated. This ensures that the FaceIds are associated with the right\n UserID. The value ranges from 0-100 and default value is 75.
If successful, an array of AssociatedFace objects containing the associated\n FaceIds is returned. If a given face is already associated with the given\n UserID, it will be ignored and will not be returned in the response. If a given\n face is already associated to a different UserID, isn't found in the collection,\n doesn’t meet the UserMatchThreshold, or there are already 100 faces associated\n with the UserID, it will be returned as part of an array of\n UnsuccessfulFaceAssociations.\n
The UserStatus reflects the status of an operation which updates a UserID\n representation with a list of given faces. The UserStatus can be:
ACTIVE - All associations or disassociations of FaceID(s) for a UserID are\n complete.
\nCREATED - A UserID has been created, but has no FaceID(s) associated with it.
\nUPDATING - A UserID is being updated and there are current associations or\n disassociations of FaceID(s) taking place.
\nThe ID of an existing collection containing the UserID.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "The ID for the existing UserID.
", + "smithy.api#required": {} + } + }, + "FaceIds": { + "target": "com.amazonaws.rekognition#UserFaceIdList", + "traits": { + "smithy.api#documentation": "An array of FaceIDs to associate with the UserID.
", + "smithy.api#required": {} + } + }, + "UserMatchThreshold": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "An optional value specifying the minimum confidence in the UserID match to return. The\n default value is 75.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", + "traits": { + "smithy.api#documentation": "Idempotent token used to identify the request to AssociateFaces. If you use\n the same token with multiple AssociateFaces requests, the same response is returned.\n Use ClientRequestToken to prevent the same request from being processed more than\n once.
An array of AssociatedFace objects containing FaceIDs that are successfully associated\n with the UserID is returned. Returned if the AssociateFaces action is successful.
" + } + }, + "UnsuccessfulFaceAssociations": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceAssociationList", + "traits": { + "smithy.api#documentation": "An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully\n associated along with the reasons. Returned if the AssociateFaces action is successful.
" + } + }, + "UserStatus": { + "target": "com.amazonaws.rekognition#UserStatus", + "traits": { + "smithy.api#documentation": "The status of an update made to a UserID. Reflects if the UserID has been updated for\n every requested change.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#AssociatedFace": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "Unique identifier assigned to the face.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides face metadata for the faces that are associated to a specific UserID.
" + } + }, + "com.amazonaws.rekognition#AssociatedFacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#AssociatedFace" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.rekognition#Attribute": { "type": "enum", "members": { @@ -589,7 +765,53 @@ } ], "traits": { - "smithy.api#documentation": "Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.
\nIf the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.
\nCompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't\n persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:CompareFaces action.
Compares a face in the source input image with each of the 100\n largest faces detected in the target input image.
\nIf the source image contains multiple faces, the service detects the largest face and\n compares it with each face detected in the target image.
\nCompareFaces uses machine learning algorithms, which are probabilistic. A false negative\n is an incorrect prediction that a face in the target image has a low similarity confidence\n score when compared to the face in the source image. To reduce the probability of false\n negatives, we recommend that you compare the target image against multiple source images. If\n you plan to use CompareFaces to make a decision that impacts an individual's\n rights, privacy, or access to services, we recommend that you pass the result to a human for\n review and further validation before taking action.
You pass the input and target images either as base64-encoded image bytes or as\n references to images in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes isn't\n supported. The image must be formatted as a PNG or JPEG file.
\nIn response, the operation returns an array of face matches ordered by similarity score\n in descending order. For each face match, the response provides a bounding box of the face,\n facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and\n confidence value (indicating the level of confidence that the bounding box contains a face).\n The response also provides a similarity score, which indicates how closely the faces match.
\nBy default, only faces with a similarity score of greater than or equal to 80% are\n returned in the response. You can change this value by specifying the\n SimilarityThreshold parameter.
\n CompareFaces also returns an array of faces that don't match the source\n image. For each face, it returns a bounding box, confidence value, landmarks, pose details,\n and quality. The response also returns information about the face in the source image,\n including the bounding box of the face and confidence value.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar by specifying LOW,\n MEDIUM, or HIGH. If you do not want to filter detected faces,\n specify NONE. The default value is NONE.
If the image doesn't contain Exif metadata, CompareFaces returns\n orientation information for the source and target images. Use these values to display the\n images with the correct image orientation.
If no faces are detected in the source or target images, CompareFaces\n returns an InvalidParameterException error.
This is a stateless API operation. That is, data returned by this operation doesn't\n persist.
\nFor an example, see Comparing Faces in Images in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:CompareFaces action.
Type that describes the face Amazon Rekognition chose to compare with the faces in the target.\n This contains a bounding box for the selected face and confidence level that the bounding box\n contains a face. Note that Amazon Rekognition selects the largest face in the source image for this\n comparison.
" } }, + "com.amazonaws.rekognition#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.rekognition#String" + }, + "Code": { + "target": "com.amazonaws.rekognition#String" + }, + "Logref": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "A universally unique identifier (UUID) for the request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. ** \n
", + "smithy.api#error": "client" + } + }, "com.amazonaws.rekognition#ConnectedHomeLabel": { "type": "string" }, @@ -974,7 +1217,30 @@ } ], "traits": { - "smithy.api#documentation": "Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
This operation requires permissions to perform the rekognition:CopyProjectVersion action.
Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and\n destination projects can be in different AWS accounts but must be in the same AWS Region.\n You can't copy a model to another AWS service.\n \n
\nTo copy a model version to a different AWS account, you need to create a resource-based policy known as a\n project policy. You attach the project policy to the\n source project by calling PutProjectPolicy. The project policy\n gives permission to copy the model version from a trusting AWS account to a trusted account.
\nFor more information creating and attaching a project policy, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nIf you are copying a model version to a project in the same AWS account, you don't need to create a project policy.
\nTo copy a model, the destination project, source project, and source model version must already exist.
\nCopying a model version takes a while to complete. To get the current status, call DescribeProjectVersions and check the value of Status in the\n ProjectVersionDescription object. The copy operation has finished when\n the value of Status is COPYING_COMPLETED.
This operation requires permissions to perform the rekognition:CopyProjectVersion action.
Creates a collection in an AWS Region. You can add faces to the collection using the\n IndexFaces operation.
\nFor example, you might create collections, one for each of your application users. A\n user can then index faces using the IndexFaces operation and persist results in a\n specific collection. Then, a user can search the collection for faces in the user-specific\n container.
When you create a collection, it is associated with the latest version of the face model\n version.
\nCollection names are case-sensitive.
\nThis operation requires permissions to perform the\n rekognition:CreateCollection action. If you want to tag your collection, you\n also require permission to perform the rekognition:TagResource\n operation.
Creates a collection in an AWS Region. You can add faces to the collection using the\n IndexFaces operation.
\nFor example, you might create collections, one for each of your application users. A\n user can then index faces using the IndexFaces operation and persist results in a\n specific collection. Then, a user can search the collection for faces in the user-specific\n container.
When you create a collection, it is associated with the latest version of the face model\n version.
\nCollection names are case-sensitive.
\nThis operation requires permissions to perform the\n rekognition:CreateCollection action. If you want to tag your collection, you\n also require permission to perform the rekognition:TagResource\n operation.
Creates a new User within a collection specified by CollectionId. Takes\n UserId as a parameter, which is a user provided ID which should be unique\n within the collection. The provided UserId will alias the system generated\n UUID to make the UserId more user friendly.
Uses a ClientToken, an idempotency token that ensures a call to\n CreateUser completes only once. If the value is not supplied, the AWS SDK\n generates an idempotency token for the requests. This prevents retries after a network\n error results from making multiple CreateUser calls.
The ID of an existing collection to which the new UserID needs to be created.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "ID for the UserID to be created. This ID needs to be unique within the collection.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", + "traits": { + "smithy.api#documentation": "Idempotent token used to identify the request to CreateUser. If you use the\n same token with multiple CreateUser requests, the same response is returned. \n Use ClientRequestToken to prevent the same request from being processed more than\n once.
Deletes the specified collection. Note that this operation removes all faces in the\n collection. For an example, see Deleting a\n collection.
\nThis operation requires permissions to perform the\n rekognition:DeleteCollection action.
Deletes the specified collection. Note that this operation removes all faces in the\n collection. For an example, see Deleting a\n collection.
\nThis operation requires permissions to perform the\n rekognition:DeleteCollection action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs\n to remove from the collection.
\nThis operation requires permissions to perform the rekognition:DeleteFaces\n action.
Deletes faces from a collection. You specify a collection ID and an array of face IDs\n to remove from the collection.
\nThis operation requires permissions to perform the rekognition:DeleteFaces\n action.
An array of strings (face IDs) of the faces that were deleted.
" } + }, + "UnsuccessfulFaceDeletions": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDeletionsList", + "traits": { + "smithy.api#documentation": "An array of any faces that weren't deleted.
" + } } }, "traits": { @@ -2256,7 +2657,19 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an existing project policy.
\nTo get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.
\nThis operation requires permissions to perform the rekognition:DeleteProjectPolicy action.
Deletes an existing project policy.
\nTo get a list of project policies attached to a project, call ListProjectPolicies. To attach a project policy to a project, call PutProjectPolicy.
\nThis operation requires permissions to perform the rekognition:DeleteProjectPolicy action.
Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.
For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.
" + "smithy.api#documentation": "Deletes the specified UserID within the collection. Faces that are associated with the\n UserID are disassociated from the UserID before deleting the specified UserID. If the\n specified Collection or UserID is already deleted or not found, a\n ResourceNotFoundException will be thrown. If the action is successful with a\n 200 response, an empty HTTP body is returned.
The ID of the collection to describe.
", + "smithy.api#documentation": "The ID of an existing collection from which the UserID needs to be deleted.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#input": {} - } - }, + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "ID for the UserID to be deleted.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", + "traits": { + "smithy.api#documentation": "Idempotent token used to identify the request to DeleteUser. If you use the\n same token with multiple DeleteUser requests, the same response is returned. \n Use ClientRequestToken to prevent the same request from being processed more than\n once.
Describes the specified collection. You can use DescribeCollection to get\n information, such as the number of faces indexed into a collection and the version of the\n model used by the collection for face detection.
For more information, see Describing a Collection in the \n Amazon Rekognition Developer Guide.
" + } + }, + "com.amazonaws.rekognition#DescribeCollectionRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.rekognition#CollectionId", + "traits": { + "smithy.api#documentation": "The ID of the collection to describe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.rekognition#DescribeCollectionResponse": { "type": "structure", "members": { @@ -2517,6 +3015,12 @@ "traits": { "smithy.api#documentation": "The number of milliseconds since the Unix epoch time until the creation of the collection.\n The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.
" } + }, + "UserCount": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "The number of UserIDs assigned to the specified colleciton.
" + } } }, "traits": { @@ -3081,7 +3585,71 @@ } ], "traits": { - "smithy.api#documentation": "Detects faces within an image that is provided as input.
\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth), pose,\n presence of facial occlusion, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the rekognition:DetectFaces\n action.
Detects faces within an image that is provided as input.
\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth), pose,\n presence of facial occlusion, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the rekognition:DetectFaces\n action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation that doesn't return any data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as\n input. This includes objects like flower, tree, and table; events like wedding, graduation,\n and birthday party; and concepts like landscape, evening, and nature.
\nFor an example, see Analyzing images stored in an Amazon S3 bucket in the\n Amazon Rekognition Developer Guide.
\nYou pass the input image as base64-encoded image bytes or as a reference to an image in\n an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n\n Optional Parameters\n
\nYou can specify one or both of the GENERAL_LABELS and\n IMAGE_PROPERTIES feature types when calling the DetectLabels API. Including\n GENERAL_LABELS will ensure the response includes the labels detected in the\n input image, while including IMAGE_PROPERTIES will ensure the response includes\n information about the image quality and color.
When using GENERAL_LABELS and/or IMAGE_PROPERTIES you can\n provide filtering criteria to the Settings parameter. You can filter with sets of individual\n labels or with label categories. You can specify inclusive filters, exclusive filters, or a\n combination of inclusive and exclusive filters. For more information on filtering see Detecting\n Labels in an Image.
You can specify MinConfidence to control the confidence threshold for the\n labels returned. The default is 55%. You can also add the MaxLabels parameter to\n limit the number of labels returned. The default and upper limit is 1000 labels.
\n Response Elements\n
\nFor each object, scene, and concept the API returns one or more labels. The API\n returns the following types of information about labels:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.\n
\nParents - The ancestor labels for a detected label. DetectLabels returns a\n hierarchical taxonomy of detected labels. For example, a detected car might be assigned\n the label car. The label car has two parent labels: Vehicle (its parent) and\n Transportation (its grandparent). The response includes the all ancestors for a label,\n where every ancestor is a unique label. In the previous example, Car, Vehicle, and\n Transportation are returned as unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common\n object labels, returned in an array of Instance objects. An Instance object contains a\n BoundingBox object, describing the location of the label on the input image. It also\n includes the confidence for the accuracy of the detected bounding box.
\nThe API returns the following information regarding the image, as part of the\n ImageProperties structure:
\nQuality - Information about the Sharpness, Brightness, and Contrast of the input\n image, scored between 0 to 100. Image quality is returned for the entire image, as well as\n the background and the foreground.
\nDominant Color - An array of the dominant colors in the image.
\nForeground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground.
\nBackground - Information about the sharpness, brightness, and dominant colors of the input image’s background.
\nThe list of returned labels will include at least one label for every detected object,\n along with information about that label. In the following example, suppose the input image has\n a lighthouse, the sea, and a rock. The response includes all three labels, one for each\n object, as well as the confidence in the label:
\n\n {Name: lighthouse, Confidence: 98.4629}\n
\n {Name: rock,Confidence: 79.2097}\n
\n {Name: sea,Confidence: 75.061}\n
The list of labels can include multiple labels for the same object. For example, if the\n input image shows a flower (for example, a tulip), the operation might return the following\n three labels.
\n\n {Name: flower,Confidence: 99.0562}\n
\n {Name: plant,Confidence: 99.0562}\n
\n {Name: tulip,Confidence: 99.0562}\n
In this example, the detection algorithm more precisely identifies the flower as a\n tulip.
\nIf the object detected is a person, the operation doesn't provide the same facial\n details that the DetectFaces operation provides.
\nThis is a stateless API operation that doesn't return any data.
\nThis operation requires permissions to perform the\n rekognition:DetectLabels action.
A set of parameters that allow you to filter out certain results from your returned results.
" } }, + "com.amazonaws.rekognition#DisassociateFaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#DisassociateFacesRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#DisassociateFacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#ConflictException" + }, + { + "target": "com.amazonaws.rekognition#IdempotentParameterMismatchException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the association between a Face supplied in an array of\n FaceIds and the User. If the User is not present already, then a\n ResourceNotFound exception is thrown. If successful, an array of faces that are\n disassociated from the User is returned. If a given face is already disassociated from the\n given UserID, it will be ignored and not be returned in the response. If a given face is\n already associated with a different User or not found in the collection it will be returned as\n part of UnsuccessfulDisassociations. You can remove 1 - 100 face IDs from a user\n at one time.
The ID of an existing collection containing the UserID.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "ID for the existing UserID.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.rekognition#ClientRequestToken", + "traits": { + "smithy.api#documentation": "Idempotent token used to identify the request to DisassociateFaces. If you\n use the same token with multiple DisassociateFaces requests, the same response is\n returned. Use ClientRequestToken to prevent the same request from being processed more than\n once.
An array of face IDs to disassociate from the UserID.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#DisassociateFacesResponse": { + "type": "structure", + "members": { + "DisassociatedFaces": { + "target": "com.amazonaws.rekognition#DisassociatedFacesList", + "traits": { + "smithy.api#documentation": "An array of DissociatedFace objects containing FaceIds that are successfully disassociated\n with the UserID is returned. Returned if the DisassociatedFaces action is successful.
" + } + }, + "UnsuccessfulFaceDisassociations": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationList", + "traits": { + "smithy.api#documentation": "An array of UnsuccessfulDisassociation objects containing FaceIds that are not\n successfully associated, along with the reasons for the failure to associate. Returned if the\n DisassociateFaces action is successful.
" + } + }, + "UserStatus": { + "target": "com.amazonaws.rekognition#UserStatus", + "traits": { + "smithy.api#documentation": "The status of an update made to a User. Reflects if the User has been updated for every requested change.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#DisassociatedFace": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "Unique identifier assigned to the face.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides face metadata for the faces that are disassociated from a specific UserID.
" + } + }, + "com.amazonaws.rekognition#DisassociatedFacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#DisassociatedFace" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.rekognition#DistributeDataset": { "type": "structure", "members": { @@ -4115,6 +4869,12 @@ "traits": { "smithy.api#documentation": "The version of the face detect and storage model that was used when indexing the face\n vector.
" } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "Unique identifier assigned to the user.
" + } } }, "traits": { @@ -6087,7 +6847,145 @@ } ], "traits": { - "smithy.api#documentation": "Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request ALL or specific facial attributes (e.g.,\n FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon Rekognition\n returns detailed facial attributes, such as facial landmarks (for example, location of eye and\n mouth), facial occlusion, and other facial attributes.
If you provide the same image, specify the same collection, and use the same external ID\n in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face\n metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request ALL or specific facial attributes (e.g.,\n FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon Rekognition\n returns detailed facial attributes, such as facial landmarks (for example, location of eye and\n mouth), facial occlusion, and other facial attributes.
If you provide the same image, specify the same collection, and use the same external ID\n in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face\n metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Returns list of collection IDs in your account. If the result is truncated, the\n response also provides a NextToken that you can use in the subsequent request to\n fetch the next set of collection IDs.
For an example, see Listing collections in the Amazon Rekognition Developer\n Guide.
\nThis operation requires permissions to perform the\n rekognition:ListCollections action.
Returns metadata for faces in the specified collection. This metadata\n includes information such as the bounding box coordinates, the confidence (that the bounding\n box contains a face), and face ID. For an example, see Listing Faces in a Collection in the\n Amazon Rekognition Developer Guide.
\nThis operation requires permissions to perform the rekognition:ListFaces\n action.
Maximum number of faces to return.
" } - } - }, - "traits": { + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "An array of user IDs to match when listing faces in a collection.
" + } + }, + "FaceIds": { + "target": "com.amazonaws.rekognition#FaceIdList", + "traits": { + "smithy.api#documentation": "An array of face IDs to match when listing faces in a collection.
" + } + } + }, + "traits": { "smithy.api#input": {} } }, @@ -7576,6 +8549,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.rekognition#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidPaginationTokenException" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns metadata of the User such as UserID in the specified collection.\n Anonymous User (to reserve faces without any identity) is not returned as part of this\n request. The results are sorted by system generated primary key ID. If the response is\n truncated, NextToken is returned in the response that can be used in the\n subsequent request to retrieve the next set of identities.
The ID of an existing collection.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.rekognition#MaxUserResults", + "traits": { + "smithy.api#documentation": "Maximum number of UsersID to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "Pagingation token to receive the next set of UsersID.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#ListUsersResponse": { + "type": "structure", + "members": { + "Users": { + "target": "com.amazonaws.rekognition#UserList", + "traits": { + "smithy.api#documentation": "List of UsersID associated with the specified collection.
" + } + }, + "NextToken": { + "target": "com.amazonaws.rekognition#PaginationToken", + "traits": { + "smithy.api#documentation": "A pagination token to be used with the subsequent request if the response is truncated.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.rekognition#LivenessImageBlob": { "type": "blob", "traits": { @@ -7683,6 +8766,26 @@ "smithy.api#error": "client" } }, + "com.amazonaws.rekognition#MatchedUser": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the UserID. Unique within the collection.
" + } + }, + "UserStatus": { + "target": "com.amazonaws.rekognition#UserStatus", + "traits": { + "smithy.api#documentation": "The status of the user matched to a provided FaceID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata for a UserID matched with a given face.
" + } + }, "com.amazonaws.rekognition#MaxDurationInSecondsULong": { "type": "long", "traits": { @@ -7726,6 +8829,15 @@ } } }, + "com.amazonaws.rekognition#MaxUserResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, "com.amazonaws.rekognition#MinCoveragePercentage": { "type": "float", "traits": { @@ -8683,7 +9795,22 @@ } ], "traits": { - "smithy.api#documentation": "Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\nYou copy a model version by calling CopyProjectVersion.
\nThis operation requires permissions to perform the rekognition:PutProjectPolicy action.
Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A\n project policy specifies that a trusted AWS account can copy a model version from a\n trusting AWS account to a project in the trusted AWS account. To copy a model version you use\n the CopyProjectVersion operation.
\nFor more information about the format of a project policy document, see Attaching a project policy (SDK)\n in the Amazon Rekognition Custom Labels Developer Guide.\n
\nThe response from PutProjectPolicy is a revision ID for the project policy.\n You can attach multiple project policies to a project. You can also update an existing\n project policy by specifying the policy revision ID of the existing policy.
To remove a project policy from a project, call DeleteProjectPolicy.\n To get a list of project policies attached to a project, call ListProjectPolicies.
\nYou copy a model version by calling CopyProjectVersion.
\nThis operation requires permissions to perform the rekognition:PutProjectPolicy action.
This is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored\n Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common\n parameters, and common errors.
\n\n Amazon Rekognition Image\n
\n\n CompareFaces\n
\n\n CreateCollection\n
\n\n DeleteCollection\n
\n\n DeleteFaces\n
\n\n DescribeCollection\n
\n\n DetectFaces\n
\n\n DetectLabels\n
\n\n DetectText\n
\n\n GetCelebrityInfo\n
\n\n IndexFaces\n
\n\n ListCollections\n
\n\n ListFaces\n
\n\n RecognizeCelebrities\n
\n\n SearchFaces\n
\n\n SearchFacesByImage\n
\n\n Amazon Rekognition Custom Labels\n
\n\n CopyProjectVersion\n
\n\n CreateDataset\n
\n\n CreateProject\n
\n\n CreateProjectVersion\n
\n\n DeleteDataset\n
\n\n DeleteProject\n
\n\n DeleteProjectPolicy\n
\n\n DeleteProjectVersion\n
\n\n DescribeDataset\n
\n\n DescribeProjects\n
\n\n DetectCustomLabels\n
\n\n ListDatasetEntries\n
\n\n ListDatasetLabels\n
\n\n ListProjectPolicies\n
\n\n PutProjectPolicy\n
\n\n StartProjectVersion\n
\n\n StopProjectVersion\n
\n\n UpdateDatasetEntries\n
\n\n Amazon Rekognition Video Stored Video\n
\n\n GetContentModeration\n
\n\n GetFaceDetection\n
\n\n GetFaceSearch\n
\n\n GetLabelDetection\n
\n\n GetPersonTracking\n
\n\n GetSegmentDetection\n
\n\n GetTextDetection\n
\n\n StartFaceDetection\n
\n\n StartFaceSearch\n
\n\n StartLabelDetection\n
\n\n StartPersonTracking\n
\n\n StartTextDetection\n
\n\n Amazon Rekognition Video Streaming Video\n
\n\n ListStreamProcessors\n
\n\n StartStreamProcessor\n
\n\n StopStreamProcessor\n
\nThis is the API Reference for Amazon Rekognition Image, Amazon Rekognition Custom Labels,\n Amazon Rekognition Stored\n Video, Amazon Rekognition Streaming Video. It provides descriptions of actions, data types, common\n parameters, and common errors.
\n\n Amazon Rekognition Image\n
\n\n AssociateFaces\n
\n\n CompareFaces\n
\n\n CreateCollection\n
\n\n CreateUser\n
\n\n DeleteCollection\n
\n\n DeleteFaces\n
\n\n DeleteUser\n
\n\n DescribeCollection\n
\n\n DetectFaces\n
\n\n DetectLabels\n
\n\n DetectText\n
\n\n DisassociateFaces\n
\n\n GetCelebrityInfo\n
\n\n IndexFaces\n
\n\n ListCollections\n
\n\n ListFaces\n
\n\n ListUsers\n
\n\n RecognizeCelebrities\n
\n\n SearchFaces\n
\n\n SearchFacesByImage\n
\n\n SearchUsers\n
\n\n SearchUsersByImage\n
\n\n Amazon Rekognition Custom Labels\n
\n\n CopyProjectVersion\n
\n\n CreateDataset\n
\n\n CreateProject\n
\n\n CreateProjectVersion\n
\n\n DeleteDataset\n
\n\n DeleteProject\n
\n\n DeleteProjectPolicy\n
\n\n DeleteProjectVersion\n
\n\n DescribeDataset\n
\n\n DescribeProjects\n
\n\n DetectCustomLabels\n
\n\n ListDatasetEntries\n
\n\n ListDatasetLabels\n
\n\n ListProjectPolicies\n
\n\n PutProjectPolicy\n
\n\n StartProjectVersion\n
\n\n StopProjectVersion\n
\n\n UpdateDatasetEntries\n
\n\n Amazon Rekognition Video Stored Video\n
\n\n GetContentModeration\n
\n\n GetFaceDetection\n
\n\n GetFaceSearch\n
\n\n GetLabelDetection\n
\n\n GetPersonTracking\n
\n\n GetSegmentDetection\n
\n\n GetTextDetection\n
\n\n StartFaceDetection\n
\n\n StartFaceSearch\n
\n\n StartLabelDetection\n
\n\n StartPersonTracking\n
\n\n StartTextDetection\n
\n\n Amazon Rekognition Video Streaming Video\n
\n\n ListStreamProcessors\n
\n\n StartStreamProcessor\n
\n\n StopStreamProcessor\n
\nFor a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.
For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input face ID, searches for matching faces in the collection the face\n belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with\n faces in the specified collection.
\nYou can also search faces without indexing faces by using the\n SearchFacesByImage operation.
The operation response returns an array of faces that match, ordered by similarity\n score with the highest similarity first. More specifically, it is an array of metadata for\n each face match that is found. Along with the metadata, the response also includes a\n confidence value for each face match, indicating the confidence that the\n specific face matches the input face.
For an example, see Searching for a face using its face ID in the Amazon Rekognition\n Developer Guide.
\nThis operation requires permissions to perform the rekognition:SearchFaces\n action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.
If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.
\nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nThis operation requires permissions to perform the\n rekognition:SearchFacesByImage action.
For a given input image, first detects the largest face in the image, and then searches\n the specified collection for matching faces. The operation compares the features of the input\n face with faces in the specified collection.
\nTo search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls\n to the SearchFaces operation.
\n You can also call the DetectFaces operation and use the bounding boxes\n in the response to make face crops, which then you can pass in to the\n SearchFacesByImage operation.
You pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the\n AWS\n CLI to call Amazon Rekognition operations, passing image bytes is not\n supported. The image must be either a PNG or JPEG formatted file.
\n The response returns an array of faces that match, ordered by similarity score with\n the highest similarity first. More specifically, it is an array of metadata for each face\n match found. Along with the metadata, the response also includes a similarity\n indicating how similar the face is to the input face. In the response, the operation also\n returns the bounding box (and a confidence level that the bounding box contains a face) of the\n face that Amazon Rekognition used for the input image.
If no faces are detected in the input image, SearchFacesByImage returns an\n InvalidParameterException error.
For an example, Searching for a Face Using an Image in the Amazon Rekognition\n Developer Guide.
\nThe QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. Use QualityFilter to set the quality bar for filtering by specifying\n LOW, MEDIUM, or HIGH. If you do not want to filter\n detected faces, specify NONE. The default value is NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nThis operation requires permissions to perform the\n rekognition:SearchFacesByImage action.
Searches for UserIDs within a collection based on a FaceId or\n UserId. This API can be used to find the closest UserID (with a highest\n similarity) to associate a face. The request must be provided with either FaceId\n or UserId. The operation returns an array of UserID that match the\n FaceId or UserId, ordered by similarity score with the highest\n similarity first.
The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
The start time of the detected segment in milliseconds from the start of the video. This value\n is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of\n 100 millis.
" - } + { + "target": "com.amazonaws.rekognition#ImageTooLargeException" }, - "EndTimestampMillis": { - "target": "com.amazonaws.rekognition#Timestamp", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The end time of the detected segment, in milliseconds, from the start of the video.\n This value is rounded down.
" - } + { + "target": "com.amazonaws.rekognition#InternalServerError" }, - "DurationMillis": { - "target": "com.amazonaws.rekognition#ULong", - "traits": { - "smithy.api#documentation": "The duration of the detected segment in milliseconds.
" - } + { + "target": "com.amazonaws.rekognition#InvalidImageFormatException" }, - "StartTimecodeSMPTE": { - "target": "com.amazonaws.rekognition#Timecode", - "traits": { - "smithy.api#documentation": "The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.\n StartTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).
The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. \n EndTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).
The duration of the timecode for the detected segment in SMPTE format.
" - } + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" }, - "TechnicalCueSegment": { - "target": "com.amazonaws.rekognition#TechnicalCueSegment", - "traits": { - "smithy.api#documentation": "If the segment is a technical cue, contains information about the technical cue.
" - } + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Searches for UserIDs using a supplied image. It first detects the largest face in the\n image, and then searches a specified collection for matching UserIDs.
\nThe operation returns an array of UserIDs that match the face in the supplied image,\n ordered by similarity score with the highest similarity first. It also returns a bounding box\n for the face found in the input image.
\nInformation about faces detected in the supplied image, but not used for the search, is\n returned in an array of UnsearchedFace objects. If no valid face is detected\n in the image, the response will contain an empty UserMatches list and no\n SearchedFace object.
The ID of an existing collection containing the UserID.
", + "smithy.api#required": {} + } + }, + "Image": { + "target": "com.amazonaws.rekognition#Image", + "traits": { + "smithy.api#required": {} + } + }, + "UserMatchThreshold": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Specifies the minimum confidence in the UserID match to return. Default value is\n 80.
" + } + }, + "MaxUsers": { + "target": "com.amazonaws.rekognition#MaxUserResults", + "traits": { + "smithy.api#documentation": "Maximum number of UserIDs to return.
" + } + }, + "QualityFilter": { + "target": "com.amazonaws.rekognition#QualityFilter", + "traits": { + "smithy.api#documentation": "A filter that specifies a quality bar for how much filtering is done to identify faces.\n Filtered faces aren't searched for in the collection. The default value is NONE.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#SearchUsersByImageResponse": { + "type": "structure", + "members": { + "UserMatches": { + "target": "com.amazonaws.rekognition#UserMatchList", + "traits": { + "smithy.api#documentation": "An array of UserID objects that matched the input face, along with the confidence in the\n match. The returned structure will be empty if there are no matches. Returned if the\n SearchUsersByImageResponse action is successful.
" + } + }, + "FaceModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "Version number of the face detection model associated with the input collection\n CollectionId.
" + } + }, + "SearchedFace": { + "target": "com.amazonaws.rekognition#SearchedFaceDetails", + "traits": { + "smithy.api#documentation": "A list of FaceDetail objects containing the BoundingBox for the largest face in image,\n as well as the confidence in the bounding box, that was searched for matches. If no valid\n face is detected in the image the response will contain no SearchedFace object.
" + } + }, + "UnsearchedFaces": { + "target": "com.amazonaws.rekognition#UnsearchedFacesList", + "traits": { + "smithy.api#documentation": "List of UnsearchedFace objects. Contains the face details infered from the specified\n image but not used for search. Contains reasons that describe why a face wasn't used for\n Search.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#SearchUsersRequest": { + "type": "structure", + "members": { + "CollectionId": { + "target": "com.amazonaws.rekognition#CollectionId", + "traits": { + "smithy.api#documentation": "The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a\n FaceId is provided, UserId isn’t required to be present in the Collection.
", + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "ID for the existing User.
" + } + }, + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "ID for the existing face.
" + } + }, + "UserMatchThreshold": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Optional value that specifies the minimum confidence in the matched UserID to return.\n Default value of 80.
" + } + }, + "MaxUsers": { + "target": "com.amazonaws.rekognition#MaxUserResults", + "traits": { + "smithy.api#documentation": "Maximum number of identities to return.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.rekognition#SearchUsersResponse": { + "type": "structure", + "members": { + "UserMatches": { + "target": "com.amazonaws.rekognition#UserMatchList", + "traits": { + "smithy.api#documentation": "An array of UserMatch objects that matched the input face along with the confidence in\n the match. Array will be empty if there are no matches.
" + } + }, + "FaceModelVersion": { + "target": "com.amazonaws.rekognition#String", + "traits": { + "smithy.api#documentation": "Version number of the face detection model associated with the input\n CollectionId.
" + } + }, + "SearchedFace": { + "target": "com.amazonaws.rekognition#SearchedFace", + "traits": { + "smithy.api#documentation": "Contains the ID of a face that was used to search for matches in a collection.
" + } + }, + "SearchedUser": { + "target": "com.amazonaws.rekognition#SearchedUser", + "traits": { + "smithy.api#documentation": "Contains the ID of the UserID that was used to search for matches in a collection.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.rekognition#SearchedFace": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "Unique identifier assigned to the face.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.
" + } + }, + "com.amazonaws.rekognition#SearchedFaceDetails": { + "type": "structure", + "members": { + "FaceDetail": { + "target": "com.amazonaws.rekognition#FaceDetail" + } + }, + "traits": { + "smithy.api#documentation": "Contains data regarding the input face used for a search.
" + } + }, + "com.amazonaws.rekognition#SearchedUser": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the UserID. Unique within the collection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata about a User searched for within a collection.
" + } + }, + "com.amazonaws.rekognition#SegmentConfidence": { + "type": "float", + "traits": { + "smithy.api#range": { + "min": 50, + "max": 100 + } + } + }, + "com.amazonaws.rekognition#SegmentDetection": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.rekognition#SegmentType", + "traits": { + "smithy.api#documentation": "The type of the segment. Valid values are TECHNICAL_CUE and SHOT.
The start time of the detected segment in milliseconds from the start of the video. This value\n is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of\n 100 millis.
" + } + }, + "EndTimestampMillis": { + "target": "com.amazonaws.rekognition#Timestamp", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The end time of the detected segment, in milliseconds, from the start of the video.\n This value is rounded down.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.rekognition#ULong", + "traits": { + "smithy.api#documentation": "The duration of the detected segment in milliseconds.
" + } + }, + "StartTimecodeSMPTE": { + "target": "com.amazonaws.rekognition#Timecode", + "traits": { + "smithy.api#documentation": "The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.\n StartTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).
The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment. \n EndTimecode is in HH:MM:SS:fr format\n (and ;fr for drop frame-rates).
The duration of the timecode for the detected segment in SMPTE format.
" + } + }, + "TechnicalCueSegment": { + "target": "com.amazonaws.rekognition#TechnicalCueSegment", + "traits": { + "smithy.api#documentation": "If the segment is a technical cue, contains information about the technical cue.
" + } }, "ShotSegment": { "target": "com.amazonaws.rekognition#ShotSegment", @@ -12526,42 +14124,319 @@ "target": "com.amazonaws.rekognition#UnindexedFace" } }, - "com.amazonaws.rekognition#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.rekognition#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.rekognition#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.rekognition#AccessDeniedException" - }, - { - "target": "com.amazonaws.rekognition#InternalServerError" - }, - { - "target": "com.amazonaws.rekognition#InvalidParameterException" - }, - { - "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" - }, - { - "target": "com.amazonaws.rekognition#ResourceNotFoundException" + "com.amazonaws.rekognition#UnsearchedFace": { + "type": "structure", + "members": { + "FaceDetails": { + "target": "com.amazonaws.rekognition#FaceDetail" }, - { - "target": "com.amazonaws.rekognition#ThrottlingException" + "Reasons": { + "target": "com.amazonaws.rekognition#UnsearchedFaceReasons", + "traits": { + "smithy.api#documentation": "Reasons why a face wasn't used for Search.
" + } } - ], + }, "traits": { - "smithy.api#documentation": "Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels\n model.
\nThis operation requires permissions to perform the\n rekognition:UntagResource action.
Face details inferred from the image but not used for search. The response attribute\n contains reasons for why a face wasn't used for Search.
" } }, - "com.amazonaws.rekognition#UntagResourceRequest": { - "type": "structure", + "com.amazonaws.rekognition#UnsearchedFaceReason": { + "type": "enum", "members": { - "ResourceArn": { + "FACE_NOT_LARGEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_NOT_LARGEST" + } + }, + "EXCEEDS_MAX_FACES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCEEDS_MAX_FACES" + } + }, + "EXTREME_POSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTREME_POSE" + } + }, + "LOW_BRIGHTNESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW_BRIGHTNESS" + } + }, + "LOW_SHARPNESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW_SHARPNESS" + } + }, + "LOW_CONFIDENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW_CONFIDENCE" + } + }, + "SMALL_BOUNDING_BOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL_BOUNDING_BOX" + } + }, + "LOW_FACE_QUALITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW_FACE_QUALITY" + } + } + } + }, + "com.amazonaws.rekognition#UnsearchedFaceReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsearchedFaceReason" + } + }, + "com.amazonaws.rekognition#UnsearchedFacesList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsearchedFace" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceAssociation": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "A unique identifier assigned to the face.
" + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the UserID. Unique within the collection.
" + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Match confidence with the UserID, provides information regarding if a face association was\n unsuccessful because it didn't meet UserMatchThreshold.
" + } + }, + "Reasons": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceAssociationReasons", + "traits": { + "smithy.api#documentation": "The reason why the association was unsuccessful.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.
" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceAssociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceAssociation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceAssociationReason": { + "type": "enum", + "members": { + "FACE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_NOT_FOUND" + } + }, + "ASSOCIATED_TO_A_DIFFERENT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_TO_A_DIFFERENT_USER" + } + }, + "LOW_MATCH_CONFIDENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW_MATCH_CONFIDENCE" + } + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceAssociationReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceAssociationReason" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDeletion": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "A unique identifier assigned to the face.
" + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the UserID. Unique within the collection.
" + } + }, + "Reasons": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDeletionReasons", + "traits": { + "smithy.api#documentation": "The reason why the deletion was unsuccessful.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.
" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDeletionReason": { + "type": "enum", + "members": { + "ASSOCIATED_TO_AN_EXISTING_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_TO_AN_EXISTING_USER" + } + }, + "FACE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_NOT_FOUND" + } + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDeletionReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDeletionReason" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDeletionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDeletion" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDisassociation": { + "type": "structure", + "members": { + "FaceId": { + "target": "com.amazonaws.rekognition#FaceId", + "traits": { + "smithy.api#documentation": "A unique identifier assigned to the face.
" + } + }, + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the UserID. Unique within the collection.
" + } + }, + "Reasons": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationReasons", + "traits": { + "smithy.api#documentation": "The reason why the deletion was unsuccessful.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.
" + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDisassociation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationReason": { + "type": "enum", + "members": { + "FACE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_NOT_FOUND" + } + }, + "ASSOCIATED_TO_A_DIFFERENT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASSOCIATED_TO_A_DIFFERENT_USER" + } + } + } + }, + "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationReasons": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UnsuccessfulFaceDisassociationReason" + } + }, + "com.amazonaws.rekognition#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.rekognition#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.rekognition#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.rekognition#AccessDeniedException" + }, + { + "target": "com.amazonaws.rekognition#InternalServerError" + }, + { + "target": "com.amazonaws.rekognition#InvalidParameterException" + }, + { + "target": "com.amazonaws.rekognition#ProvisionedThroughputExceededException" + }, + { + "target": "com.amazonaws.rekognition#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.rekognition#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels\n model.
\nThis operation requires permissions to perform the\n rekognition:UntagResource action.
Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to\n remove the tags from.
", @@ -12750,6 +14625,121 @@ } } }, + "com.amazonaws.rekognition#User": { + "type": "structure", + "members": { + "UserId": { + "target": "com.amazonaws.rekognition#UserId", + "traits": { + "smithy.api#documentation": "A provided ID for the User. Unique within the collection.
" + } + }, + "UserStatus": { + "target": "com.amazonaws.rekognition#UserStatus", + "traits": { + "smithy.api#documentation": "Communicates if the UserID has been updated with latest set of faces to be associated\n with the UserID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata of the user stored in a collection.
" + } + }, + "com.amazonaws.rekognition#UserFaceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#FaceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.rekognition#UserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.\\-:]+$" + } + }, + "com.amazonaws.rekognition#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#User" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.rekognition#UserMatch": { + "type": "structure", + "members": { + "Similarity": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "Describes the UserID metadata.
" + } + }, + "User": { + "target": "com.amazonaws.rekognition#MatchedUser", + "traits": { + "smithy.api#documentation": "Confidence in the match of this UserID with the input face.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides UserID metadata along with the confidence in the match of this UserID with the\n input face.
" + } + }, + "com.amazonaws.rekognition#UserMatchList": { + "type": "list", + "member": { + "target": "com.amazonaws.rekognition#UserMatch" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.rekognition#UserStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + } + } + }, "com.amazonaws.rekognition#ValidationData": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json index 0ad15797ede..3deda4be7dc 100644 --- a/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json +++ b/codegen/sdk-codegen/aws-models/route-53-domains.2014-05-15.json @@ -74,7 +74,8 @@ } }, "traits": { - "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telements.
" + "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#AcceptDomainTransferFromAnotherAwsAccountResponse": { @@ -88,7 +89,8 @@ } }, "traits": { - "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
" + "smithy.api#documentation": "The AcceptDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#AccountId": { @@ -159,6 +161,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#AssociateDelegationSignerToDomainResponse": { @@ -170,6 +175,9 @@ "smithy.api#documentation": "The identifier for tracking the progress of the request. To query the operation\n\t\t\tstatus, use GetOperationDetail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.route53domains#BillingRecord": { @@ -255,7 +263,8 @@ } }, "traits": { - "smithy.api#documentation": "The CancelDomainTransferToAnotherAwsAccount request includes the following\n\t\t\telement.
" + "smithy.api#documentation": "The CancelDomainTransferToAnotherAwsAccount request includes the following\n\t\t\telement.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#CancelDomainTransferToAnotherAwsAccountResponse": { @@ -269,7 +278,8 @@ } }, "traits": { - "smithy.api#documentation": "The CancelDomainTransferToAnotherAwsAccount response includes the\n\t\t\tfollowing element.
The CancelDomainTransferToAnotherAwsAccount response includes the\n\t\t\tfollowing element.
The CheckDomainAvailability request contains the following elements.
" + "smithy.api#documentation": "The CheckDomainAvailability request contains the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#CheckDomainAvailabilityResponse": { @@ -324,7 +335,8 @@ } }, "traits": { - "smithy.api#documentation": "The CheckDomainAvailability response includes the following elements.
" + "smithy.api#documentation": "The CheckDomainAvailability response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#CheckDomainTransferability": { @@ -365,7 +377,8 @@ } }, "traits": { - "smithy.api#documentation": "The CheckDomainTransferability request contains the following elements.
" + "smithy.api#documentation": "The CheckDomainTransferability request contains the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#CheckDomainTransferabilityResponse": { @@ -379,7 +392,8 @@ } }, "traits": { - "smithy.api#documentation": "The CheckDomainTransferability response includes the following elements.
" + "smithy.api#documentation": "The CheckDomainTransferability response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#City": { @@ -2125,6 +2139,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#DeleteDomainResponse": { @@ -2136,6 +2153,9 @@ "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.route53domains#DeleteTagsForDomain": { @@ -2180,12 +2200,16 @@ } }, "traits": { - "smithy.api#documentation": "The DeleteTagsForDomainRequest includes the following elements.
" + "smithy.api#documentation": "The DeleteTagsForDomainRequest includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#DeleteTagsForDomainResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.route53domains#DisableDomainAutoRenew": { "type": "operation", @@ -2217,11 +2241,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#DisableDomainAutoRenewResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.route53domains#DisableDomainTransferLock": { "type": "operation", @@ -2264,7 +2294,8 @@ } }, "traits": { - "smithy.api#documentation": "The DisableDomainTransferLock request includes the following element.
" + "smithy.api#documentation": "The DisableDomainTransferLock request includes the following element.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#DisableDomainTransferLockResponse": { @@ -2278,7 +2309,8 @@ } }, "traits": { - "smithy.api#documentation": "The DisableDomainTransferLock response includes the following element.
" + "smithy.api#documentation": "The DisableDomainTransferLock response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomain": { @@ -2327,6 +2359,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#DisassociateDelegationSignerFromDomainResponse": { @@ -2338,6 +2373,9 @@ "smithy.api#documentation": "Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.route53domains#DnssecKey": { @@ -2742,11 +2780,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#EnableDomainAutoRenewResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.route53domains#EnableDomainTransferLock": { "type": "operation", @@ -2789,7 +2833,8 @@ } }, "traits": { - "smithy.api#documentation": "A request to set the transfer lock for the specified domain.
" + "smithy.api#documentation": "A request to set the transfer lock for the specified domain.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#EnableDomainTransferLockResponse": { @@ -2803,7 +2848,8 @@ } }, "traits": { - "smithy.api#documentation": "The EnableDomainTransferLock response includes the following elements.
" + "smithy.api#documentation": "The EnableDomainTransferLock response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#ErrorMessage": { @@ -2815,7 +2861,7 @@ "Name": { "target": "com.amazonaws.route53domains#ExtraParamName", "traits": { - "smithy.api#documentation": "The name of an additional parameter that is required by a top-level domain. Here are\n\t\t\tthe top-level domains that require additional parameters and the names of the parameters\n\t\t\tthat they require:
\n\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial\n\t\t\t\t\t\t\t\t\t\tcompany)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance\n\t\t\t\t\t\t\t\t\t\tassociations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité\n\t\t\t\t\t\t\t\t\t\tlimitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values\n\t\t\t\t\t\t\t\tinclude the following:
\n ABO (Aboriginal Peoples indigenous to\n\t\t\t\t\t\t\t\t\t\tCanada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian\n\t\t\t\t\t\t\t\t\t\tCitizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than\n\t\t\t\t\t\t\t\t\tPERSON, valid values include the following:
\n ASS (Canadian unincorporated\n\t\t\t\t\t\t\t\t\t\tassociation)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act\n\t\t\t\t\t\t\t\t\t\tof Canada)
\n LAM (Canadian Library, Archive, or\n\t\t\t\t\t\t\t\t\t\tMuseum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
The value of ES_IDENTIFICATION depends on the\n\t\t\t\t\t\t\t\tfollowing values:
The value of ES_LEGAL_FORM\n
The value of ES_IDENTIFICATION_TYPE\n
\n If ES_LEGAL_FORM is any value\n\t\t\t\t\t\t\t\t\tother than INDIVIDUAL:\n
Specify 1 letter + 8 numbers (CIF [Certificado de\n\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: B12345678
\n\n If ES_LEGAL_FORM is\n\t\t\t\t\t\t\t\t\t\tINDIVIDUAL, the value that you specify for\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION_TYPE:\n
If ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tDNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento\n\t\t\t\t\t\t\t\t\t\t\t\tNacional de Identidad], NIF [Número de\n\t\t\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: 12345678M
\nIf ES_IDENTIFICATION_TYPE is NIE\n\t\t\t\t\t\t\t\t\t\t(for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE\n\t\t\t\t\t\t\t\t\t\t\t\t[Número de Identidad de Extranjero])
\nExample: Y1234567X
\nIf ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tOTHER (for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain):
Specify a passport number, drivers license number,\n\t\t\t\t\t\t\t\t\t\t\t\tor national identity card number
\n\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal\n\t\t\t\t\t\t\t\t\t\tresidence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n EU_COUNTRY_OF_CITIZENSHIP\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n BIRTH_CITY\n
\n BIRTH_COUNTRY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n BIRTH_DEPARTMENT: Specify the INSEE code that\n\t\t\t\t\t\t\t\tcorresponds with the department where the contact was born. If the\n\t\t\t\t\t\t\t\tcontact was born somewhere other than France or its overseas\n\t\t\t\t\t\t\t\tdepartments, specify 99. For more information,\n\t\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers,\n\t\t\t\t\t\t\t\tsee the Wikipedia entry Departments of France.
\n BRAND_NUMBER\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and\n\t\t\t\t\t\t\t\t\t\tprofessionals)
\n ITALIAN_COMPANIES (Italian companies and\n\t\t\t\t\t\t\t\t\t\tone-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing\n\t\t\t\t\t\t\t\t\t\tself)
\n FOTHER (Non-UK Entity that does not fit into\n\t\t\t\t\t\t\t\t\t\tany other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing\n\t\t\t\t\t\t\t\t\t\tself))
\n IP (UK Industrial/Provident Registered\n\t\t\t\t\t\t\t\t\t\tCompany)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any\n\t\t\t\t\t\t\t\t\t\tother category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
The name of an additional parameter that is required by a top-level domain. Here are\n\t\t\tthe top-level domains that require additional parameters and the names of the parameters\n\t\t\tthat they require:
\n\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial\n\t\t\t\t\t\t\t\t\t\tcompany)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance\n\t\t\t\t\t\t\t\t\t\tassociations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité\n\t\t\t\t\t\t\t\t\t\tlimitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values\n\t\t\t\t\t\t\t\tinclude the following:
\n ABO (Aboriginal Peoples indigenous to\n\t\t\t\t\t\t\t\t\t\tCanada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian\n\t\t\t\t\t\t\t\t\t\tCitizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than\n\t\t\t\t\t\t\t\t\tPERSON, valid values include the following:
\n ASS (Canadian unincorporated\n\t\t\t\t\t\t\t\t\t\tassociation)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act\n\t\t\t\t\t\t\t\t\t\tof Canada)
\n LAM (Canadian Library, Archive, or\n\t\t\t\t\t\t\t\t\t\tMuseum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in\n\t\t\t\t\t\t\t\t\t\tCanada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
The value of ES_IDENTIFICATION depends on the\n\t\t\t\t\t\t\t\tfollowing values:
The value of ES_LEGAL_FORM\n
The value of ES_IDENTIFICATION_TYPE\n
\n If ES_LEGAL_FORM is any value\n\t\t\t\t\t\t\t\t\tother than INDIVIDUAL:\n
Specify 1 letter + 8 numbers (CIF [Certificado de\n\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: B12345678
\n\n If ES_LEGAL_FORM is\n\t\t\t\t\t\t\t\t\t\tINDIVIDUAL, the value that you specify for\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of\n\t\t\t\t\t\t\t\t\t\tES_IDENTIFICATION_TYPE:\n
If ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tDNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento\n\t\t\t\t\t\t\t\t\t\t\t\tNacional de Identidad], NIF [Número de\n\t\t\t\t\t\t\t\t\t\t\t\tIdentificación Fiscal])
\nExample: 12345678M
\nIf ES_IDENTIFICATION_TYPE is NIE\n\t\t\t\t\t\t\t\t\t\t(for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE\n\t\t\t\t\t\t\t\t\t\t\t\t[Número de Identidad de Extranjero])
\nExample: Y1234567X
\nIf ES_IDENTIFICATION_TYPE is\n\t\t\t\t\t\t\t\t\t\t\tOTHER (for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain):
Specify a passport number, drivers license number,\n\t\t\t\t\t\t\t\t\t\t\t\tor national identity card number
\n\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal\n\t\t\t\t\t\t\t\t\t\tresidence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of\n\t\t\t\t\t\t\t\t\t\tSpain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n EU_COUNTRY_OF_CITIZENSHIP\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and\n\t\t\t\t\t\t\t\t\t\tprofessionals)
\n ITALIAN_COMPANIES (Italian companies and\n\t\t\t\t\t\t\t\t\t\tone-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing\n\t\t\t\t\t\t\t\t\t\tself)
\n FOTHER (Non-UK Entity that does not fit into\n\t\t\t\t\t\t\t\t\t\tany other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing\n\t\t\t\t\t\t\t\t\t\tself))
\n IP (UK Industrial/Provident Registered\n\t\t\t\t\t\t\t\t\t\tCompany)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any\n\t\t\t\t\t\t\t\t\t\tother category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
The name of the domain for which you want to know whether the registrant contact has\n\t\t\tconfirmed that the email address is valid.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#GetContactReachabilityStatusResponse": { @@ -3132,6 +3181,9 @@ "smithy.api#documentation": "Whether the registrant contact has responded. Values include the following:
\nWe sent the confirmation email and haven't received a response yet.
\nWe sent the email and got confirmation from the registrant contact.
\nThe time limit expired before the registrant contact responded.
\nThe GetDomainDetail request includes the following element.
" + "smithy.api#documentation": "The GetDomainDetail request includes the following element.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#GetDomainDetailResponse": { @@ -3306,7 +3359,8 @@ } }, "traits": { - "smithy.api#documentation": "The GetDomainDetail response includes the following elements.
" + "smithy.api#documentation": "The GetDomainDetail response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#GetDomainSuggestions": { @@ -3354,6 +3408,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#GetDomainSuggestionsResponse": { @@ -3365,6 +3422,9 @@ "smithy.api#documentation": "A list of possible domain names. If you specified true for\n\t\t\t\tOnlyAvailable in the request, the list contains only domains that are\n\t\t\tavailable for registration.
The GetOperationDetail request includes the following element.
" + "smithy.api#documentation": "The GetOperationDetail request includes the following element.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#GetOperationDetailResponse": { @@ -3452,7 +3513,8 @@ } }, "traits": { - "smithy.api#documentation": "The GetOperationDetail response includes the following elements.
" + "smithy.api#documentation": "The GetOperationDetail response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#GlueIp": { @@ -3592,7 +3654,8 @@ } }, "traits": { - "smithy.api#documentation": "The ListDomains request includes the following elements.
" + "smithy.api#documentation": "The ListDomains request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ListDomainsResponse": { @@ -3612,7 +3675,8 @@ } }, "traits": { - "smithy.api#documentation": "The ListDomains response includes the following elements.
" + "smithy.api#documentation": "The ListDomains response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#ListOperations": { @@ -3685,7 +3749,8 @@ } }, "traits": { - "smithy.api#documentation": "The ListOperations request includes the following elements.
" + "smithy.api#documentation": "The ListOperations request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ListOperationsResponse": { @@ -3705,7 +3770,8 @@ } }, "traits": { - "smithy.api#documentation": "The ListOperations response includes the following elements.
" + "smithy.api#documentation": "The ListOperations response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#ListOperationsSortAttributeName": { @@ -3745,6 +3811,14 @@ } } }, + "com.amazonaws.route53domains#ListPricesPageMaxItems": { + "type": "integer", + "traits": { + "smithy.api#range": { + "max": 1000 + } + } + }, "com.amazonaws.route53domains#ListPricesRequest": { "type": "structure", "members": { @@ -3761,11 +3835,14 @@ } }, "MaxItems": { - "target": "com.amazonaws.route53domains#PageMaxItems", + "target": "com.amazonaws.route53domains#ListPricesPageMaxItems", "traits": { "smithy.api#documentation": "Number of Prices to be returned.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tMaxItems.
If there are more prices than you specified for MaxItems in the request,\n\t\t\tsubmit another request and include the value of NextPageMarker in the value\n\t\t\tof Marker.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\t\tNextPageMarker.
The ListTagsForDomainRequest includes the following elements.
" + "smithy.api#documentation": "The ListTagsForDomainRequest includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ListTagsForDomainResponse": { @@ -3834,7 +3915,8 @@ } }, "traits": { - "smithy.api#documentation": "The ListTagsForDomain response includes the following elements.
" + "smithy.api#documentation": "The ListTagsForDomain response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#Nameserver": { @@ -4235,6 +4317,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ReachabilityStatus": { @@ -4289,7 +4374,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation registers a domain. Domains are registered either by Amazon Registrar\n\t\t\t(for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other\n\t\t\tdomains). For some top-level domains (TLDs), this operation requires extra\n\t\t\tparameters.
\nWhen you register a domain, Amazon Route 53 does the following:
\nCreates a Route 53 hosted zone that has the same name as the domain. Route 53\n\t\t\t\t\tassigns four name servers to your hosted zone and automatically updates your\n\t\t\t\t\tdomain registration with the names of these name servers.
\nEnables auto renew, so your domain registration will renew automatically each\n\t\t\t\t\tyear. We'll notify you in advance of the renewal date so you can choose whether\n\t\t\t\t\tto renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact\n\t\t\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or\n\t\t\t\t\tfor our registrar associate, Gandi (for all other TLDs). If you don't enable\n\t\t\t\t\tprivacy protection, WHOIS queries return the information that you entered for\n\t\t\t\t\tthe administrative, registrant, and technical contacts.
\nYou must specify the same privacy setting for the administrative,\n\t\t\t\t\t\tregistrant, and technical contacts.
\nIf registration is successful, returns an operation ID that you can use to\n\t\t\t\t\ttrack the progress and completion of the action. If the request is not completed\n\t\t\t\t\tsuccessfully, the domain registrant is notified by email.
\nCharges your Amazon Web Services account an amount based on the top-level\n\t\t\t\t\tdomain. For more information, see Amazon Route 53 Pricing.
\nThis operation registers a domain. For some top-level domains (TLDs), this operation\n\t\t\trequires extra parameters.
\nWhen you register a domain, Amazon Route 53 does the following:
\nCreates a Route 53 hosted zone that has the same name as the domain. Route 53\n\t\t\t\t\tassigns four name servers to your hosted zone and automatically updates your\n\t\t\t\t\tdomain registration with the names of these name servers.
\nEnables auto renew, so your domain registration will renew automatically each\n\t\t\t\t\tyear. We'll notify you in advance of the renewal date so you can choose whether\n\t\t\t\t\tto renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact for the registrar\n\t\t\t\t\tor the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of
While some domains may allow different privacy settings per contact, we recommend\n\t\t\t\t\t\tspecifying the same privacy setting for all contacts.
\nIf registration is successful, returns an operation ID that you can use to\n\t\t\t\t\ttrack the progress and completion of the action. If the request is not completed\n\t\t\t\t\tsuccessfully, the domain registrant is notified by email.
\nCharges your Amazon Web Services account an amount based on the top-level\n\t\t\t\t\tdomain. For more information, see Amazon Route 53 Pricing.
\nThe RegisterDomain request includes the following elements.
" + "smithy.api#documentation": "The RegisterDomain request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#RegisterDomainResponse": { @@ -4376,7 +4462,8 @@ } }, "traits": { - "smithy.api#documentation": "The RegisterDomain response includes the following element.
" + "smithy.api#documentation": "The RegisterDomain response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#RegistrarName": { @@ -4426,7 +4513,8 @@ } }, "traits": { - "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telement.
" + "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount request includes the following\n\t\t\telement.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#RejectDomainTransferFromAnotherAwsAccountResponse": { @@ -4440,7 +4528,8 @@ } }, "traits": { - "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
" + "smithy.api#documentation": "The RejectDomainTransferFromAnotherAwsAccount response includes the following\n\t\t\telement.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#RenewDomain": { @@ -4498,7 +4587,8 @@ } }, "traits": { - "smithy.api#documentation": "A RenewDomain request includes the number of years that you want to renew\n\t\t\tfor and the current expiration year.
A RenewDomain request includes the number of years that you want to renew\n\t\t\tfor and the current expiration year.
Identifier for tracking the progress of the request. To query the operation status,\n\t\t\tuse GetOperationDetail.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.route53domains#Reseller": { @@ -4547,6 +4640,9 @@ "smithy.api#documentation": "The name of the domain for which you want Route 53 to resend a confirmation email to\n\t\t\tthe registrant contact.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ResendContactReachabilityEmailResponse": { @@ -4570,6 +4666,9 @@ "smithy.api#documentation": "\n True if the email address for the registrant contact has already been\n\t\t\tverified, and false otherwise. If the email address has already been\n\t\t\tverified, we don't send another confirmation email.
A request for the authorization code for the specified domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.
" + "smithy.api#documentation": "A request for the authorization code for the specified domain. To transfer a domain to\n\t\t\tanother registrar, you provide this value to the new registrar.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#RetrieveDomainAuthCodeResponse": { @@ -4647,7 +4750,8 @@ } }, "traits": { - "smithy.api#documentation": "The RetrieveDomainAuthCode response includes the following element.
" + "smithy.api#documentation": "The RetrieveDomainAuthCode response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#Route53Domains_v20140515": { @@ -5633,7 +5737,7 @@ } ], "traits": { - "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53. When the transfer is\n\t\t\tcomplete, the domain is registered either with Amazon Registrar (for .com, .net, and\n\t\t\t.org domains) or with our registrar associate, Gandi (for all other TLDs).
\nFor more information about transferring domains, see the following topics:
\nFor transfer requirements, a detailed procedure, and information about viewing\n\t\t\t\t\tthe status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
\nFor information about how to transfer a domain to another domain registrar,\n\t\t\t\t\tsee Transferring a Domain from Amazon Route 53 to Another Registrar in\n\t\t\t\t\tthe Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.
\nIf the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.
\nIf the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53.
\nFor more information about transferring domains, see the following topics:
\nFor transfer requirements, a detailed procedure, and information about viewing\n\t\t\t\t\tthe status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the\n\t\t\t\t\t\tAmazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
\nFor information about how to transfer a domain to another domain registrar,\n\t\t\t\t\tsee Transferring a Domain from Amazon Route 53 to Another Registrar in\n\t\t\t\t\tthe Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we\n\t\t\thighly recommend that you transfer your DNS service to Route 53 or to another DNS\n\t\t\tservice provider before you transfer your registration. Some registrars provide free DNS\n\t\t\tservice when you purchase a domain registration. When you transfer the registration, the\n\t\t\tprevious registrar will not renew your domain registration and could end your DNS\n\t\t\tservice at any time.
\nIf the registrar for your domain is also the DNS service provider for the domain\n\t\t\t\tand you don't transfer DNS service to another provider, your website, email, and the\n\t\t\t\tweb applications associated with the domain might become unavailable.
\nIf the transfer is successful, this method returns an operation ID that you can use to\n\t\t\ttrack the progress and completion of the action. If the transfer doesn't complete\n\t\t\tsuccessfully, the domain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -5701,7 +5805,7 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information either for\n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or for our registrar associate,\n\t\t\tGandi (for all other TLDs). If you specify false, WHOIS queries return the\n\t\t\tinformation that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify\n\t\t\t\ttrue, WHOIS (\"who is\") queries return contact information for the\n\t\t\tregistrar, the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of
While some domains may allow different privacy settings per contact, we recommend\n\t\t\t\tspecifying the same privacy setting for all contacts.
\nDefault: true\n
The TransferDomain request includes the following elements.
" + "smithy.api#documentation": "The TransferDomain request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#TransferDomainResponse": { @@ -5732,7 +5837,8 @@ } }, "traits": { - "smithy.api#documentation": "The TransferDomain response includes the following element.
" + "smithy.api#documentation": "The TransferDomain response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#TransferDomainToAnotherAwsAccount": { @@ -5780,7 +5886,8 @@ } }, "traits": { - "smithy.api#documentation": "The TransferDomainToAnotherAwsAccount request includes the following elements.
" + "smithy.api#documentation": "The TransferDomainToAnotherAwsAccount request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#TransferDomainToAnotherAwsAccountResponse": { @@ -5800,7 +5907,8 @@ } }, "traits": { - "smithy.api#documentation": "The TransferDomainToAnotherAwsAccount response includes the following\n\t\t\telements.
The TransferDomainToAnotherAwsAccount response includes the following\n\t\t\telements.
This operation updates the specified domain contact's privacy setting. When privacy\n\t\t\tprotection is enabled, contact information such as email address is replaced either with\n\t\t\tcontact information for Amazon Registrar (for .com, .net, and .org domains) or with\n\t\t\tcontact information for our registrar associate, Gandi.
\nYou must specify the same privacy setting for the administrative, registrant, and\n\t\t\t\ttechnical contacts.
\nThis operation affects only the contact information for the specified contact type\n\t\t\t(administrative, registrant, or technical). If the request succeeds, Amazon Route 53\n\t\t\treturns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If\n\t\t\tthe request doesn't complete successfully, the domain registrant will be notified by\n\t\t\temail.
\nBy disabling the privacy service via API, you consent to the publication of the\n\t\t\t\tcontact information provided for this domain via the public WHOIS database. You\n\t\t\t\tcertify that you are the registrant of this domain name and have the authority to\n\t\t\t\tmake this decision. You may withdraw your consent at any time by enabling privacy\n\t\t\t\tprotection using either UpdateDomainContactPrivacy or the Route 53\n\t\t\t\tconsole. Enabling privacy protection removes the contact information provided for\n\t\t\t\tthis domain from the WHOIS database. For more information on our privacy practices,\n\t\t\t\tsee https://aws.amazon.com/privacy/.
This operation updates the specified domain contact's privacy setting. When privacy\n\t\t\tprotection is enabled, your contact information is replaced with contact information for\n\t\t\tthe registrar or with the phrase \"REDACTED FOR PRIVACY\", or \"On behalf of
While some domains may allow different privacy settings per contact, we recommend\n\t\t\t\tspecifying the same privacy setting for all contacts.
\nThis operation affects only the contact information for the specified contact type\n\t\t\t(administrative, registrant, or technical). If the request succeeds, Amazon Route 53\n\t\t\treturns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If\n\t\t\tthe request doesn't complete successfully, the domain registrant will be notified by\n\t\t\temail.
\nBy disabling the privacy service via API, you consent to the publication of the\n\t\t\t\tcontact information provided for this domain via the public WHOIS database. You\n\t\t\t\tcertify that you are the registrant of this domain name and have the authority to\n\t\t\t\tmake this decision. You may withdraw your consent at any time by enabling privacy\n\t\t\t\tprotection using either UpdateDomainContactPrivacy or the Route 53\n\t\t\t\tconsole. Enabling privacy protection removes the contact information provided for\n\t\t\t\tthis domain from the WHOIS database. For more information on our privacy practices,\n\t\t\t\tsee https://aws.amazon.com/privacy/.
The UpdateDomainContactPrivacy request includes the following elements.
" + "smithy.api#documentation": "The UpdateDomainContactPrivacy request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#UpdateDomainContactPrivacyResponse": { @@ -5965,7 +6074,8 @@ } }, "traits": { - "smithy.api#documentation": "The UpdateDomainContactPrivacy response includes the following element.
" + "smithy.api#documentation": "The UpdateDomainContactPrivacy response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#UpdateDomainContactRequest": { @@ -5999,12 +6109,13 @@ "Consent": { "target": "com.amazonaws.route53domains#Consent", "traits": { - "smithy.api#documentation": "Customer's consent for the owner change request.
" + "smithy.api#documentation": "Customer's consent for the owner change request. Required if the domain is not free (consent price is more than $0.00).
" } } }, "traits": { - "smithy.api#documentation": "The UpdateDomainContact request includes the following elements.
" + "smithy.api#documentation": "The UpdateDomainContact request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#UpdateDomainContactResponse": { @@ -6018,7 +6129,8 @@ } }, "traits": { - "smithy.api#documentation": "The UpdateDomainContact response includes the following element.
" + "smithy.api#documentation": "The UpdateDomainContact response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#UpdateDomainNameservers": { @@ -6076,7 +6188,8 @@ } }, "traits": { - "smithy.api#documentation": "Replaces the current set of name servers for the domain with the specified set of name\n\t\t\tservers. If you use Amazon Route 53 as your DNS service, specify the four name servers\n\t\t\tin the delegation set for the hosted zone for the domain.
\nIf successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.
" + "smithy.api#documentation": "Replaces the current set of name servers for the domain with the specified set of name\n\t\t\tservers. If you use Amazon Route 53 as your DNS service, specify the four name servers\n\t\t\tin the delegation set for the hosted zone for the domain.
\nIf successful, this operation returns an operation ID that you can use to track the\n\t\t\tprogress and completion of the action. If the request is not completed successfully, the\n\t\t\tdomain registrant will be notified by email.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#UpdateDomainNameserversResponse": { @@ -6090,7 +6203,8 @@ } }, "traits": { - "smithy.api#documentation": "The UpdateDomainNameservers response includes the following element.
" + "smithy.api#documentation": "The UpdateDomainNameservers response includes the following element.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#UpdateTagsForDomain": { @@ -6134,12 +6248,16 @@ } }, "traits": { - "smithy.api#documentation": "The UpdateTagsForDomainRequest includes the following elements.
" + "smithy.api#documentation": "The UpdateTagsForDomainRequest includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#UpdateTagsForDomainResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.route53domains#Value": { "type": "string", @@ -6214,7 +6332,8 @@ } }, "traits": { - "smithy.api#documentation": "The ViewBilling request includes the following elements.
" + "smithy.api#documentation": "The ViewBilling request includes the following elements.
", + "smithy.api#input": {} } }, "com.amazonaws.route53domains#ViewBillingResponse": { @@ -6234,7 +6353,8 @@ } }, "traits": { - "smithy.api#documentation": "The ViewBilling response includes the following elements.
" + "smithy.api#documentation": "The ViewBilling response includes the following elements.
", + "smithy.api#output": {} } }, "com.amazonaws.route53domains#ZipCode": { diff --git a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json index a08417723f5..f0227a4af82 100644 --- a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json +++ b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json @@ -62,6 +62,18 @@ ], "traits": { "smithy.api#documentation": "This action aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts action and ensure that\n the parts list is empty.
\nFor information about permissions required to use the multipart upload, see Multipart Upload\n and Permissions.
\nThe following operations are related to AbortMultipartUpload:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20053,7 +21541,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20335,7 +21823,24 @@ } ], "traits": { - "smithy.api#documentation": "Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the\n Region that you want to copy the object from and the Region that you want to copy the\n object to must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. If you call the S3 API directly, make\n sure to design your application to parse the contents of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the\n embedded error and apply error handling per your configuration settings (including\n automatically retrying the request as appropriate). If the condition persists, the SDKs\n throws an exception (or, for the SDKs that don't use exceptions, they return the\n error).
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer\n Acceleration.
When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n x-amz-website-redirect-location is unique to each object and must be\n specified in the request headers to copy the value.
To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy request, the\n encryption setting of the target object is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.
\nWhen you perform a CopyObject operation, if you want to use a different type\n of encryption setting for the target object, you can use other appropriate\n encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed\n key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts the data when you access it. If the\n encryption setting in your request is different from the default encryption configuration\n of the destination bucket, the encryption setting in your request takes precedence. If the\n source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary\n encryption information in your request so that Amazon S3 can decrypt the object for copying. For\n more information about server-side encryption, see Using Server-Side\n Encryption.
\nIf a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For\n more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use\n this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nWhen copying an object, if it has a checksum, that checksum will be copied to the new\n object by default. When you copy the object over, you may optionally specify a different\n checksum algorithm to use with the x-amz-checksum-algorithm header.
You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 using the StorageClass parameter. For more\n information, see Storage Classes in the\n Amazon S3 User Guide.
If the source object's storage class is GLACIER, you must restore a copy of\n this object before you can use it as a source object for the copy operation. For\n more information, see RestoreObject. For\n more information, see Copying\n Objects.
\nBy default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nThe following operations are related to CopyObject:
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the\n Region that you want to copy the object from and the Region that you want to copy the\n object to must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. If you call the S3 API directly, make\n sure to design your application to parse the contents of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the\n embedded error and apply error handling per your configuration settings (including\n automatically retrying the request as appropriate). If the condition persists, the SDKs\n throws an exception (or, for the SDKs that don't use exceptions, they return the\n error).
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer\n Acceleration.
When copying an object, you can preserve all metadata (the default) or specify new metadata.\n However, the access control list (ACL) is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n x-amz-website-redirect-location is unique to each object and must be\n specified in the request headers to copy the value.
To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy\n request, the encryption setting of the target object is set to the default\n encryption configuration of the destination bucket. By default, all buckets have a\n base level of encryption configuration that uses server-side encryption with Amazon S3\n managed keys (SSE-S3). If the destination bucket has a default encryption\n configuration that uses server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or\n server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses\n the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.
\nWhen you perform a CopyObject operation, if you want to use a different type\n of encryption setting for the target object, you can use other appropriate\n encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed\n key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it\n writes your data to disks in its data centers and decrypts the data when you access it. If the\n encryption setting in your request is different from the default encryption configuration\n of the destination bucket, the encryption setting in your request takes precedence. If the\n source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary\n encryption information in your request so that Amazon S3 can decrypt the object for copying. For\n more information about server-side encryption, see Using Server-Side\n Encryption.
If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the\n object. For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use\n this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nWhen copying an object, if it has a checksum, that checksum will be copied to the new\n object by default. When you copy the object over, you can optionally specify a different\n checksum algorithm to use with the x-amz-checksum-algorithm header.
You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 by using the StorageClass parameter. For more\n information, see Storage Classes in the\n Amazon S3 User Guide.
If the source object's storage class is GLACIER, you must restore a copy of\n this object before you can use it as a source object for the copy operation. For\n more information, see RestoreObject. For\n more information, see Copying\n Objects.
\nBy default, x-amz-copy-source header identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nThe following operations are related to CopyObject:
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20413,7 +21918,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the copied object uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the copied object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20594,7 +22099,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests\n for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services\n CLI, see Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the KMS key ID to use for object encryption. All GET and PUT requests for an\n object protected by KMS will fail if they're not made via SSL or using SigV4. For\n information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see\n Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20651,7 +22156,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS 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 a COPY action doesn’t affect bucket-level settings for S3\n Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20870,7 +22375,19 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of\n buckets.
When creating a bucket using this operation, you can optionally configure the bucket ACL\n to specify the accounts or groups that should be granted specific permissions on the\n bucket.
\nIf your CreateBucket request sets bucket owner enforced for S3 Object Ownership and\n specifies a bucket ACL that provides access to an external Amazon Web Services account, your request\n fails with a 400 error and returns the\n InvalidBucketAclWithObjectOwnership error code. For more information,\n see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request\n headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list (ACL)\n overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\nIn addition to s3:CreateBucket, the following permissions are required when\n your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request\n specifies ACL permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through any other\n ACL, both s3:CreateBucket and s3:PutBucketAcl permissions\n are needed. If the ACL the CreateBucket request is private or doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nCreates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of\n buckets.
In addition to s3:CreateBucket, the following permissions are required when\n your CreateBucket request includes specific headers:
\n Access control lists (ACLs) - If your CreateBucket request\n specifies access control list (ACL) permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through any other\n ACL, both s3:CreateBucket and s3:PutBucketAcl permissions\n are needed. If the ACL for the CreateBucket request is private or if the request doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the\n s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are disabled. We recommend keeping\n ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the ObjectOwnership setting, you can use the \n x-amz-object-ownership header in your CreateBucket request to set the ObjectOwnership setting of your choice.\n For more information about S3 Object Ownership, see Controlling object\n ownership in the Amazon S3 User Guide.
\n S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the \n DeletePublicAccessBlock\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock permission. By default, all Block\n Public Access settings are enabled for new buckets. To avoid inadvertent exposure of\n your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see Blocking public\n access to your Amazon S3 storage in the Amazon S3 User Guide.
If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership\n and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information,\n see Setting Object\n Ownership on an existing bucket in the Amazon S3 User Guide.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nThis action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.
\nFor more information about multipart uploads, see Multipart Upload Overview.
\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
\nFor information about the permissions required to use the multipart upload API, see\n Multipart\n Upload and Permissions.
\nFor request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).
\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.
\nServer-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. Amazon S3\n automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a\n multipart upload, if you don't specify encryption information in your request, the\n encryption setting of the uploaded parts is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded\n parts. When you perform a CreateMultipartUpload operation, if you want to use a different\n type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the\n object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption\n setting in your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence. If you choose\n to provide your own encryption key, the request headers you provide in UploadPart\n and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload. You can request that Amazon S3\n save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key\n (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key\n (SSE-C).
To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester\n must have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions and Protecting data using\n server-side encryption with Amazon Web Services KMS in the\n Amazon S3 User Guide.
If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key,\n then you must have these permissions on the key policy. If your IAM user or role belongs\n to a different account than the key, then you must have the permissions on both the key\n policy and your IAM user or role.
\nFor more information, see Protecting Data Using Server-Side\n Encryption.
\nWhen copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:
\nSpecify a canned ACL with the x-amz-acl request header. For\n more information, see Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nAmazon S3 encrypts data\n by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can request that Amazon S3 encrypts\n data at rest by using server-side encryption with other key options. The option you use depends on\n whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys\n (SSE-C).
\nUse KMS keys (SSE-KMS) that include the Amazon Web Services managed key\n (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you\n want Amazon Web Services to manage the keys used to encrypt data, specify the following\n headers in the request.
\n x-amz-server-side-encryption\n
\n x-amz-server-side-encryption-aws-kms-key-id\n
\n x-amz-server-side-encryption-context\n
If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to\n protect the data.
All GET and PUT requests for an object protected\n by KMS fail if you don't make them by using Secure Sockets Layer (SSL),\n Transport Layer Security (TLS), or Signature Version 4.
For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting Data\n Using Server-Side Encryption with KMS keys.
\nUse customer-provided encryption keys (SSE-C) – If you want to manage\n your own encryption keys, provide all the following headers in the\n request.
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about server-side encryption with customer-provided\n encryption keys (SSE-C), see \n Protecting data using server-side encryption with customer-provided\n encryption keys (SSE-C).
\nYou also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual\n Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then\n added to the access control list (ACL) on the object. For more information, see\n Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:
\nSpecify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.
Specify access permissions explicitly — To explicitly grant access\n permissions to specific Amazon Web Services accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview. In the header, you specify a list of grantees who get\n the specific permission. To grant permissions explicitly, use:
\n\n x-amz-grant-read\n
\n x-amz-grant-write\n
\n x-amz-grant-read-acp\n
\n x-amz-grant-write-acp\n
\n x-amz-grant-full-control\n
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id – if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
The following operations are related to CreateMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -21087,7 +22619,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -21219,7 +22751,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
Specifies the ID of the symmetric encryption customer managed key to use for object encryption.\n All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL\n or using SigV4. For information about configuring using any of the officially supported\n Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the ID of the symmetric encryption customer managed key to use for object encryption.\n All GET and PUT requests for an object protected by KMS will fail if they're not made via\n SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services\n SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -21276,7 +22808,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS 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 bucket-level settings for S3\n Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -21388,7 +22920,7 @@ "Objects": { "target": "com.amazonaws.s3#ObjectIdentifierList", "traits": { - "smithy.api#documentation": "The objects to delete.
", + "smithy.api#documentation": "The object to delete.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Object" @@ -21416,6 +22948,15 @@ }, "traits": { "smithy.api#documentation": "Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\nThe following operations are related to DeleteBucket:
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
The following operations are related to DeleteBucketCors:
\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nDeletes the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\n Related Resources\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nDeletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.
\nFor more information about the object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThis implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n Amazon Web Services account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.
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.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.
\nThe following operations are related to DeleteBucketPolicy\n
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nDeletes the tags from the bucket.
\nTo use this operation, you must have permission to perform the\n s3:PutBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThis action removes the website configuration for a bucket. Amazon S3 returns a 200\n OK response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if\n the bucket specified in the request does not exist.
This DELETE action requires the S3:DeleteBucketWebsite permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite\n permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
\nThe following operations are related to DeleteBucketWebsite:
\n GetBucketWebsite\n
\n\n PutBucketWebsite\n
\nRemoves the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects but will still respond that the command was successful.
\nTo remove a specific version, you must use the version Id subresource. Using this\n subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header, x-amz-delete-marker, to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample\n requests that use versioning, see Sample\n Request.
\nYou can delete objects by explicitly calling DELETE Object or configure its lifecycle\n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject, s3:DeleteObjectVersion, and\n s3:PutLifeCycleConfiguration actions.
The following action is related to DeleteObject:
\n PutObject\n
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.
To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.
The following operations are related to DeleteObjectTagging:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nIf the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only\n supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.
If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only\n supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service\n Developer Guide.
The accelerate configuration of the bucket.
" } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } } }, "traits": { @@ -23051,6 +24677,12 @@ "smithy.api#documentation": "The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.
\n To use this operation, you must have permission to perform the\n s3:GetBucketCORS action. By default, the bucket owner has this permission\n and can grant it to others.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.
\nThe following operations are related to GetBucketCors:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information\n about the bucket default encryption feature, see Amazon S3 Bucket\n Default Encryption in the Amazon S3 User Guide.
\nTo use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption:
\n PutBucketEncryption\n
\nReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets\n have a default encryption configuration that uses server-side encryption with Amazon S3 managed\n keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket\n Default Encryption in the Amazon S3 User Guide.
\nTo use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption:
\n PutBucketEncryption\n
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier action, see GetBucketLifecycle.
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.
\nTo use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\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 operations are related to\n GetBucketLifecycleConfiguration:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.
\nThe following operations are related to GetBucketLocation:
\n GetObject\n
\n\n CreateBucket\n
\nReturns the policy of a specified 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 GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy 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.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
For more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nThe following action is related to GetBucketPolicy:
\n GetObject\n
\nReturns the replication configuration of a bucket.
\nIt can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThis action requires permissions for the s3:GetReplicationConfiguration\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.
If you include the Filter element in a replication configuration, you must\n also include the DeleteMarkerReplication and Priority elements.\n The response also returns those elements.
For information about GetBucketReplication errors, see List of\n replication-related error codes\n
The following operations are related to GetBucketReplication:
\n PutBucketReplication\n
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.
\nThe following operations are related to GetBucketRequestPayment:
\n ListObjects\n
\nReturns the tag set associated with the bucket.
\nTo use this operation, you must have permission to perform the\n s3:GetBucketTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.
\n GetBucketTagging has the following special error:
Error code: NoSuchTagSet\n
Description: There is no tag set associated with the bucket.
\nThe following operations are related to GetBucketTagging:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nReturns the versioning state of a bucket.
\nTo retrieve the versioning state of a bucket, you must be the bucket owner.
\nThis implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled, the bucket owner must use an authentication\n device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning:
\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.
\nThis GET action requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.
The following operations are related to GetBucketWebsite:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nRetrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification.
For more information about returning the ACL of an object, see GetObjectAcl.
\nIf the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectState error. For information about restoring archived objects,\n see Restoring\n Archived Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with KMS keys\n (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nAssuming you have the relevant permission to read object tags, the response also returns\n the x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
You need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions in a\n Policy. If the object you request does not exist, the error Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
If you supply a versionId, you need the\n s3:GetObjectVersion permission to access a specific version of an\n object. If you request a specific version, you do not need to have the\n s3:GetObject permission. If you request the current version\n without a specific version ID, only s3:GetObject permission is\n required. s3:GetObjectVersion permission won't be required.
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response\n header value in your GET request.
You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nRetrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n you can name it photos/2006/February/sample.jpg.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification.
For more information about returning the ACL of an object, see GetObjectAcl.
\nIf the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectState error. For information about restoring archived objects,\n see Restoring\n Archived Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with Key Management Service (KMS)\n keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or\n server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use\n these types of keys, you’ll get an HTTP 400 Bad Request error.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nAssuming you have the relevant permission to read object tags, the response also returns\n the x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
You need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions in a\n Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 (Not Found) error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an\n HTTP status code 403 (\"access denied\") error.
By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
If you supply a versionId, you need the\n s3:GetObjectVersion permission to access a specific version of an\n object. If you request a specific version, you do not need to have the\n s3:GetObject permission. If you request the current version\n without a specific version ID, only s3:GetObject permission is\n required. s3:GetObjectVersion permission won't be required.
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response\n header value in your GET request.
You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl permissions or READ_ACP access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n
This action is not supported by Amazon S3 on Outposts.
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetObjectAcl:
\n GetObject\n
\n\n GetObjectAttributes\n
\n\n DeleteObject\n
\n\n PutObject\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -24900,7 +26742,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services\n KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -25221,6 +27063,29 @@ }, "traits": { "smithy.api#documentation": "Returns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging\n action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nReturns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following action is related to GetObjectTorrent:
\n GetObject\n
\nThis action is useful to determine if a bucket exists and you have permission to access\n it. The action returns a 200 OK if the bucket exists and you have permission\n to access it.
If the bucket does not exist or you do not have permission to access it, the\n HEAD request returns a generic 400 Bad Request, 403\n Forbidden or 404 Not Found code. A message body is not included, so\n you cannot determine the exception beyond these error codes.
To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
To use this API operation against an access point, you must provide the alias of the access point in place of the\n bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to\n the access point hostname. The access point hostname takes the form\n AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.\n When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more\n information, see Using access points.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
The HEAD action retrieves metadata from an object without returning the object itself.\n This action is useful if you're only interested in an object's metadata. To use HEAD, you\n must have READ access to the object.
\nA HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 400 Bad Request, 403 Forbidden or 404 Not\n Found code. It is not possible to retrieve the exact exception beyond these error\n codes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption,\n should not be sent for GET requests if your object uses server-side encryption\n with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption\n keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400\n BadRequest error.
The last modified property in this case is the creation date of the\n object.
\nRequest headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:
\n If-Match condition evaluates to true, and;
\n If-Unmodified-Since condition evaluates to\n false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:
\n If-None-Match condition evaluates to false,\n and;
\n If-Modified-Since condition evaluates to\n true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Actions, resources, and condition keys for Amazon S3. \n If the object you request does not exist, the error Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
\nIf you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe HEAD action retrieves metadata from an object without returning the object itself.\n This action is useful if you're only interested in an object's metadata. To use HEAD, you\n must have READ access to the object.
A HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 400 Bad Request, 403 Forbidden or 404 Not\n Found code. It is not possible to retrieve the exact exception beyond these error\n codes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption,\n should not be sent for GET requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). If your object does use these types of keys,\n you’ll get an HTTP 400 Bad Request error.
The last modified property in this case is the creation date of the\n object.
\nRequest headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:
\n If-Match condition evaluates to true, and;
\n If-Unmodified-Since condition evaluates to\n false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:
\n If-None-Match condition evaluates to false,\n and;
\n If-Modified-Since condition evaluates to\n true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Actions, resources, and condition keys for Amazon S3. \n If the object you request doesn't exist, the error that Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
\nIf you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 error.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -25861,7 +27746,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services\n KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -27238,6 +29123,32 @@ }, "traits": { "smithy.api#documentation": "Returns a list of all buckets owned by the authenticated sender of the request. To use\n this operation, you must have the s3:ListAllMyBuckets permission.
For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.
", + "smithy.api#examples": [ + { + "title": "To list all buckets", + "documentation": "The following example returns all the buckets owned by the sender of this request.", + "output": { + "Owner": { + "DisplayName": "own-display-name", + "ID": "examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31" + }, + "Buckets": [ + { + "CreationDate": "2012-02-15T21:03:02.000Z", + "Name": "examplebucket" + }, + { + "CreationDate": "2011-07-24T19:33:50.000Z", + "Name": "examplebucket2" + }, + { + "CreationDate": "2010-12-17T00:56:49.000Z", + "Name": "examplebucket3" + } + ] + } + } + ], "smithy.api#http": { "method": "GET", "uri": "/", @@ -27362,6 +29273,12 @@ "traits": { "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object keys in the response.
\nIf you specify encoding-type request parameter, Amazon S3 includes this element\n in the response, and returns encoded key name values in the following response\n elements:
\n Delimiter, KeyMarker, Prefix,\n NextKeyMarker, Key.
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n To use this operation, you must have permissions to perform the\n s3:ListBucketVersions action. Be aware of the name difference.
A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.
\nTo use this operation, you must have READ access to the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operations are related to ListObjectVersions:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nEncoding type used by Amazon S3 to encode object key names in the XML response.
\nIf you specify encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:
\n\n KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
Encoding type used by Amazon S3 to encode object keys in the response.
" } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } } }, "traits": { @@ -27885,6 +29866,12 @@ "traits": { "smithy.api#documentation": "If StartAfter was sent with the request, it is included in the response.
" } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } } }, "traits": { @@ -29736,7 +31723,18 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe following operations are related to PutBucketAcl:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions by using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe following operations are related to PutBucketAcl:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nSets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS\n action. By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin header must match AllowedOrigin\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.
Every header specified in the Access-Control-Request-Headers request\n header of a pre-flight request must match an AllowedHeader element.\n
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\nThe following operations are related to PutBucketCors:
\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis action uses the encryption subresource to configure default encryption\n and Amazon S3 Bucket Keys for an existing bucket.
By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3).\n You can optionally configure default encryption for a bucket by using server-side\n encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption,\n see Amazon S3\n bucket default encryption in the Amazon S3 User Guide. For more\n information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\nThis action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
The following operations are related to PutBucketEncryption:
\n GetBucketEncryption\n
\nThis action uses the encryption subresource to configure default encryption\n and Amazon S3 Bucket Keys for an existing bucket.
By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS),\n dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side\n encryption with customer-provided keys (SSE-C). If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default\n encryption, see Amazon S3 bucket default encryption\n in the Amazon S3 User Guide. For more information about S3 Bucket Keys, see\n Amazon S3 Bucket\n Keys in the Amazon S3 User Guide.
\nThis action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).
\nTo use this operation, you must have permission to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
The following operations are related to PutBucketEncryption:
\n GetBucketEncryption\n
\nSpecifies default encryption for a bucket using server-side encryption with different\n key options. By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side\n encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies default encryption for a bucket using server-side encryption with different\n key options. By default, all buckets have a default encryption configuration that uses\n server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure\n default encryption for a bucket by using server-side encryption with an Amazon Web Services KMS key\n (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -30159,7 +32200,36 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle\n configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists\n of the following:
\nFilter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.
\nStatus whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.
\nFor more information, see Object Lifecycle Management\n and Lifecycle Configuration Elements.
\nBy default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access Permissions to\n Your Amazon S3 Resources.
\nThe following operations are related to PutBucketLifecycleConfiguration:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle\n configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists\n of the following:
\nA filter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.
\nA status indicating whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.
\nFor more information, see Object Lifecycle Management\n and Lifecycle Configuration Elements.
\nBy default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.
You can also explicitly deny permissions. An explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access Permissions to\n Your Amazon S3 Resources.
\nThe following operations are related to PutBucketLifecycleConfiguration:
Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.
You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n
For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.
You can specify the person (grantee) to whom you're assigning access rights (by using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
\n DisplayName is optional and ignored in the request.
By Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl\n request, appears as the CanonicalUser.
By URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n
For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration:
\n GetBucketLifecycle has the following special error:
Error code: TooManyConfigurations\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration:
\n PutBucketMetricsConfiguration has the following special error:
Error code: TooManyConfigurations\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nEnables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.
\n
\n \n
This action replaces the existing notification configuration with the configuration you\n include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.
\nIf the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration:
Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.
\n
\n \n
This action replaces the existing notification configuration with the configuration you\n include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with the required s3:PutBucketNotification permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.
\nIf the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration:
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
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.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
For more information, see Bucket policy\n examples.
\nThe following operations are related to PutBucketPolicy:
\n CreateBucket\n
\n\n DeleteBucket\n
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.
\nA replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.
\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nFor information about enabling versioning on a bucket, see Using Versioning.
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:\n SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using KMS keys.
For information on PutBucketReplication errors, see List of\n replication-related error codes\n
To create a PutBucketReplication request, you must have\n s3:PutReplicationConfiguration permissions for the bucket.\n \n
By default, a resource owner, in this case the Amazon Web Services account that created the bucket,\n can perform this operation. The resource owner can also grant others permissions to perform\n the operation. For more information about permissions, see Specifying Permissions in a\n Policy and Managing Access Permissions to\n Your Amazon S3 Resources.
\nTo perform this operation, the user or role performing the action must have the\n iam:PassRole permission.
\nThe following operations are related to PutBucketReplication:
\n GetBucketReplication\n
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\nThe following operations are related to PutBucketRequestPayment:
\n CreateBucket\n
\nSets the tags for a bucket.
\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 and Using Cost Allocation in Amazon S3 Bucket\n Tags.
\nWhen this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about 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 User-Defined Tag Restrictions and 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. Please try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nThe following operations are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nSets the versioning state of an existing bucket.
\nYou can set the versioning state with one of the following values:
\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\nIn order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request header and the Status and the\n MfaDelete request elements in a request to set the versioning state of the\n bucket.
If you have an object expiration lifecycle configuration in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.
\nThe following operations are related to PutBucketVersioning:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nSets the configuration of the website that is specified in the website\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT action requires the S3:PutBucketWebsite permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite permission.
To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.
\n\n WebsiteConfiguration\n
\n RedirectAllRequestsTo\n
\n HostName\n
\n Protocol\n
If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.
\n\n WebsiteConfiguration\n
\n IndexDocument\n
\n Suffix\n
\n ErrorDocument\n
\n Key\n
\n RoutingRules\n
\n RoutingRule\n
\n Condition\n
\n HttpErrorCodeReturnedEquals\n
\n KeyPrefixEquals\n
\n Redirect\n
\n Protocol\n
\n HostName\n
\n ReplaceKeyPrefixWith\n
\n ReplaceKeyWith\n
\n HttpRedirectCode\n
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon S3 User Guide.
", + "smithy.api#examples": [ + { + "title": "Set website configuration on a bucket", + "documentation": "The following example adds website configuration to a bucket.", + "input": { + "Bucket": "examplebucket", + "ContentMD5": "", + "WebsiteConfiguration": { + "IndexDocument": { + "Suffix": "index.html" + }, + "ErrorDocument": { + "Key": "error.html" + } + } + } + } + ], "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?website", @@ -30911,7 +33120,23 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.
\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the\n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request,\n you must have the s3:PutObjectAcl in your IAM permissions.
To successfully set the tag-set with your PutObject request, you\n must have the s3:PutObjectTagging in your IAM permissions.
The Content-MD5 header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.
You have three mutually exclusive options to protect data using server-side encryption\n in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and\n customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using\n Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at by\n rest using server-side encryption with other key options. For more information, see Using\n Server-Side Encryption.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nFor more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.
\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the\n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request,\n you must have the s3:PutObjectAcl in your IAM permissions.
To successfully set the tag-set with your PutObject request, you\n must have the s3:PutObjectTagging in your IAM permissions.
The Content-MD5 header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.
You have four mutually exclusive options to protect data using server-side encryption in\n Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or\n DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side\n encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to\n encrypt data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nFor more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nUses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.
The following operations are related to PutObjectAcl:
\n CopyObject\n
\n\n GetObject\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
If x-amz-server-side-encryption is has a valid value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object.
If x-amz-server-side-encryption has a valid value of aws:kms\n or aws:kms:dsse, this header specifies the ID of the Key Management Service (KMS)\n symmetric encryption customer managed key that was used for the object.
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -31543,7 +33782,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms, aws:kms:dsse).
If x-amz-server-side-encryption has a valid value of aws:kms,\n this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object. If you specify\n x-amz-server-side-encryption:aws:kms, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to\n protect the data. If the KMS key does not exist in the same account issuing the command,\n you must use the full ARN and not just the ID.
If x-amz-server-side-encryption has a valid value of aws:kms\n or aws:kms:dsse, this header specifies the ID of the Key Management Service (KMS)\n symmetric encryption customer managed key that was used for the object. If you specify\n x-amz-server-side-encryption:aws:kms or\n x-amz-server-side-encryption:aws:kms:dsse, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key\n (aws/s3) to protect the data. If the KMS key does not exist in the same\n account that's issuing the command, you must use the full ARN and not just the ID.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS 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 a PUT action doesn’t affect bucket-level settings for S3\n Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to\n true causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -31776,6 +34015,31 @@ "requestChecksumRequired": true }, "smithy.api#documentation": "Sets the supplied tag-set to an object that already exists in a bucket.
\nA tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.
\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
\n\n PutObjectTagging has the following special errors:
\n Code: InvalidTagError \n
\n\n Cause: The tag provided was not a valid tag. This error can occur\n if the tag did not pass input validation. For more information, see Object\n Tagging.\n
\n\n Code: MalformedXMLError \n
\n\n Cause: The XML provided does not match the schema.\n
\n\n Code: OperationAbortedError \n
\n\n Cause: A conflicting conditional action is currently in progress\n against this resource. Please try again.\n
\n\n Code: InternalError\n
\n\n Cause: The service was unable to apply the provided tag to the\n object.\n
\nThe following operations are related to PutObjectTagging:
\n GetObjectTagging\n
\n\n DeleteObjectTagging\n
\nRestores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select - Perform a select query on an archived object
\n restore an archive - Restore an archived object
For more information about the S3 structure in the request body, see the\n following:
\n PutObject\n
\n\n Managing Access with ACLs in the\n Amazon S3 User Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon S3 User Guide\n
\nDefine the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n
If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n
When making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle configuration.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n duplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.
To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
Objects that you archive to the S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage\n classes, you must first initiate a restore request, and then wait until a temporary copy of\n the object is available. If you want a permanent copy of the object, create a copy of it in\n the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must\n restore the object for the duration (number of days) that you specify. For objects in the\n Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first\n initiate a restore request, and then wait until the object is moved into the Frequent\n Access tier.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object, you can specify one of the following data access tier\n options in the Tier element of the request body:
\n Expedited - Expedited retrievals allow you to quickly access your\n data stored in the S3 Glacier Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives\n are required. For all but the largest archived objects (250 MB+), data accessed using\n Expedited retrievals is typically made available within 1–5 minutes. Provisioned\n capacity ensures that retrieval capacity for Expedited retrievals is available when\n you need it. Expedited retrievals and provisioned capacity are not available for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
\n Standard - Standard retrievals allow you to access any of your\n archived objects within several hours. This is the default option for retrieval\n requests that do not specify the retrieval option. Standard retrievals typically\n finish within 3–5 hours for objects stored in the S3 Glacier Flexible\n Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within\n 12 hours for objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in\n S3 Intelligent-Tiering.
\n Bulk - Bulk retrievals free for objects stored in the S3 Glacier\n Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to\n retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically\n finish within 5–12 hours for objects stored in the S3 Glacier\n Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are\n also the lowest-cost retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for objects\n stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\n tier.
For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in\n the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3\n Event Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management\n in Amazon S3 User Guide.
\nA successful action returns either the 200 OK or 202 Accepted\n status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the\n response.
Special errors:
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\nThe following operations are related to RestoreObject:
Restores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select - Perform a select query on an archived object
\n restore an archive - Restore an archived object
For more information about the S3 structure in the request body, see the\n following:
\n PutObject\n
\n\n Managing Access with ACLs in the\n Amazon S3 User Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon S3 User Guide\n
\nDefine the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n
If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n
When making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle configuration.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n duplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.
To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage\n classes, you must first initiate a restore request, and then wait until a temporary copy of\n the object is available. If you want a permanent copy of the object, create a copy of it in\n the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must\n restore the object for the duration (number of days) that you specify. For objects in the\n Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first\n initiate a restore request, and then wait until the object is moved into the Frequent\n Access tier.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object, you can specify one of the following data access tier\n options in the Tier element of the request body:
\n Expedited - Expedited retrievals allow you to quickly access your\n data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives\n are required. For all but the largest archived objects (250 MB+), data accessed using\n Expedited retrievals is typically made available within 1–5 minutes. Provisioned\n capacity ensures that retrieval capacity for Expedited retrievals is available when\n you need it. Expedited retrievals and provisioned capacity are not available for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
\n Standard - Standard retrievals allow you to access any of your\n archived objects within several hours. This is the default option for retrieval\n requests that do not specify the retrieval option. Standard retrievals typically\n finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible\n Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within\n 12 hours for objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in\n S3 Intelligent-Tiering.
\n Bulk - Bulk retrievals free for objects stored in the S3 Glacier\n Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to\n retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically\n finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval\n Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are\n also the lowest-cost retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for objects\n stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\n tier.
For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in\n the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3\n Event Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management\n in Amazon S3 User Guide.
\nA successful action returns either the 200 OK or 202 Accepted\n status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the\n response.
Special errors:
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\nThe following operations are related to RestoreObject:
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption\n customer managed key to use for encrypting inventory reports.
", + "smithy.api#documentation": "Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for\n encrypting inventory reports.
", "smithy.api#required": {} } } @@ -32808,7 +35089,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying\n Permissions in a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys\n (SSE-KMS), server-side encryption is handled transparently, so you don't need to\n specify anything. For more information about server-side encryption, including SSE-S3\n and SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage\n Classes in the Amazon S3 User Guide.
For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent:
\n GetObject\n
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying\n Permissions in a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys\n (SSE-KMS), server-side encryption is handled transparently, so you don't need to\n specify anything. For more information about server-side encryption, including SSE-S3\n and SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and \n DEEP_ARCHIVE_ACCESS access tiers of \n the INTELLIGENT_TIERING storage class: You cannot query objects in \n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the \n ARCHIVE_ACCESS or \n DEEP_ARCHIVE_ACCESS access tiers of \n the INTELLIGENT_TIERING storage class. For\n more information about storage classes, see Using Amazon S3 storage\n classes in the Amazon S3 User Guide.
For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent:
\n GetObject\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -33723,7 +36010,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -33893,7 +36180,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key\n was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -33957,7 +36244,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, diff --git a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json index b110ed74984..e20b9189db8 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.2017-07-24.json @@ -256,7 +256,7 @@ "target": "com.amazonaws.sagemaker#AddTagsOutput" }, "traits": { - "smithy.api#documentation": "Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain or CreateUserProfile.
Adds or overwrites one or more tags for the specified SageMaker resource. You can add\n tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform\n jobs, models, labeling jobs, work teams, endpoint configurations, and\n endpoints.
\nEach tag consists of a key and an optional value. Tag keys must be unique per\n resource. For more information about tags, see For more information, see Amazon Web Services Tagging Strategies.
\nTags that you add to a hyperparameter tuning job by calling this API are also\n added to any training jobs that the hyperparameter tuning job launches after you\n call this API, but not to training jobs that the hyperparameter tuning job launched\n before you called this API. To make sure that the tags associated with a\n hyperparameter tuning job are also added to all training jobs that the\n hyperparameter tuning job launches, add the tags when you first create the tuning\n job by specifying them in the Tags parameter of CreateHyperParameterTuningJob\n
Tags that you add to a SageMaker Studio Domain or User Profile by calling this API\n are also added to any Apps that the Domain or User Profile launches after you call\n this API, but not to Apps that the Domain or User Profile launched before you called\n this API. To make sure that the tags associated with a Domain or User Profile are\n also added to all Apps that the Domain or User Profile launches, add the tags when\n you first create the Domain or User Profile by specifying them in the\n Tags parameter of CreateDomain\n or CreateUserProfile.
Specifies the training algorithm to use in a CreateTrainingJob\n request.
\nFor more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
" + "smithy.api#documentation": "Specifies the training algorithm to use in a CreateTrainingJob request.
\nFor more information about algorithms provided by SageMaker, see Algorithms. For\n information about using your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
" } }, "com.amazonaws.sagemaker#AlgorithmStatus": { @@ -1820,7 +1820,7 @@ "IncludeInferenceResponseIn": { "target": "com.amazonaws.sagemaker#AsyncNotificationTopicTypeList", "traits": { - "smithy.api#documentation": "The Amazon SNS topics where you want the inference response to be included.
\nThe inference response is included only if the response size is less than or equal to 128 KB.
\nThe Amazon SNS topics where you want the inference response to be included.
\nThe inference response is included only if the response size is less than or equal\n to 128 KB.
\nThe mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the V2 API only (for example,\n for jobs created by calling CreateAutoMLJobV2).
The mapping of all supported processing unit (CPU, GPU, etc...) to inference container\n definitions for the candidate. This field is populated for the AutoML jobs V2 (for example,\n for jobs created by calling CreateAutoMLJobV2) related to image or text\n classification problem types only.
If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and\n the selection of the best model. This column\n is not considered as a predictive feature. For more information on Autopilot metrics,\n see Metrics and validation.
\nSample weights should be numeric, non-negative, with larger values\n indicating which rows are more important than others. Data points that have invalid or no\n weight value are excluded.
\nSupport for sample weights\n is available in Ensembling\n mode only.
" + "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" } } }, @@ -2458,7 +2458,7 @@ } }, "traits": { - "smithy.api#documentation": "This structure specifies how to split the data into train and validation\n datasets.
\nIf you are using the V1 API (for example CreateAutoMLJob) or the V2 API for\n Natural Language Processing problems (for example CreateAutoMLJobV2 with a\n TextClassificationJobConfig problem type), the validation and training\n datasets must contain the same headers. Also, for V1 API jobs, the validation dataset must\n be less than 2 GB in size.
This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
The content type of the data from the input source. The following are the allowed\n content types for different problems:
\nImageClassification: image/png, image/jpeg,\n image/*\n
TextClassification: text/csv;header=present\n
The content type of the data from the input source. The following are the allowed\n content types for different problems:
\nFor Tabular problem types: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
For ImageClassification: image/png, image/jpeg, or\n image/*. The default value is image/*.
For TextClassification: text/csv;header=present or\n x-application/vnd.amazon+parquet. The default value is\n text/csv;header=present.
The allowed compression types depend on the input format. We allow the compression type\n Gzip for S3Prefix inputs only. For all other inputs, the\n compression type should be None. If no compression type is provided, we\n default to None.
The allowed compression types depend on the input format and problem type. We allow the\n compression type Gzip for S3Prefix inputs on tabular data only.\n For all other inputs, the compression type should be None. If no compression\n type is provided, we default to None.
The data source for an AutoML channel.
" + "smithy.api#documentation": "The data source for an AutoML channel (Required).
" } } }, "traits": { - "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. This channel is\n used for the non tabular training data of an AutoML job using the V2 API. For tabular\n training data, see AutoMLChannel. For\n more information, see Channel.
" + "smithy.api#documentation": "A channel is a named input source that training algorithms can consume. This channel is\n used for AutoML jobs V2 (jobs created by calling CreateAutoMLJobV2).
" } }, "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria": { @@ -2572,13 +2572,13 @@ "MaxCandidates": { "target": "com.amazonaws.sagemaker#MaxCandidates", "traits": { - "smithy.api#documentation": "The maximum number of times a training job is allowed to run.
\nFor V2 jobs (jobs created by calling CreateAutoMLJobV2), the supported\n value is 1.
The maximum number of times a training job is allowed to run.
\nFor job V2s (jobs created by calling CreateAutoMLJobV2), the supported\n value is 1.
The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.
\nFor V2 jobs (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.
The maximum time, in seconds, that each training job executed inside hyperparameter\n tuning is allowed to run as part of a hyperparameter tuning job. For more information, see\n the StoppingCondition\n used by the CreateHyperParameterTuningJob action.
\nFor job V2s (jobs created by calling CreateAutoMLJobV2), this field\n controls the runtime of the job candidate.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nFor the list of all available metrics supported by Autopilot, see Autopilot\n metrics.
\nIf you do not specify a metric explicitly, the default behavior is to automatically\n use:
\n\n MSE: for regression.
\n F1: for binary classification
\n Accuracy: for multiclass classification.
The name of the objective metric used to measure the predictive quality of a machine\n learning system. During training, the model's parameters are updated iteratively to\n optimize its performance based on the feedback provided by the objective metric when\n evaluating the model on the validation dataset.
\nFor the list of all available metrics supported by Autopilot, see Autopilot\n metrics.
\nIf you do not specify a metric explicitly, the default behavior is to automatically\n use:
\nFor tabular problem types:
\nRegression: MSE.
Binary classification: F1.
Multiclass classification: Accuracy.
For image or text classification problem types: Accuracy\n
Specifies a metric to minimize or maximize as the objective of a job. V2 API jobs (for\n example jobs created by calling CreateAutoMLJobV2), support\n Accuracy only.
Specifies a metric to minimize or maximize as the objective of a job.
" } }, "com.amazonaws.sagemaker#AutoMLJobObjectiveType": { @@ -3194,18 +3194,61 @@ "ImageClassificationJobConfig": { "target": "com.amazonaws.sagemaker#ImageClassificationJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job using the V2 API for the image classification\n problem type.
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the image classification problem\n type.
" } }, "TextClassificationJobConfig": { "target": "com.amazonaws.sagemaker#TextClassificationJobConfig", "traits": { - "smithy.api#documentation": "Settings used to configure an AutoML job using the V2 API for the text classification\n problem type.
" + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for the text classification problem\n type.
" + } + }, + "TabularJobConfig": { + "target": "com.amazonaws.sagemaker#TabularJobConfig", + "traits": { + "smithy.api#documentation": "Settings used to configure an AutoML job V2 for a tabular problem type (regression,\n classification).
" + } + } + }, + "traits": { + "smithy.api#documentation": "A collection of settings specific to the problem type used to configure an AutoML job V2.\n There must be one and only one config of the following type.
" + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName": { + "type": "enum", + "members": { + "IMAGE_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ImageClassification" + } + }, + "TEXT_CLASSIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TextClassification" + } + }, + "TABULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tabular" + } + } + } + }, + "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes": { + "type": "union", + "members": { + "TabularResolvedAttributes": { + "target": "com.amazonaws.sagemaker#TabularResolvedAttributes", + "traits": { + "smithy.api#documentation": "Defines the resolved attributes for the TABULAR problem type.
A collection of settings specific to the problem type used to configure an AutoML job\n using the V2 API. There must be one and only one config of the following type.
" + "smithy.api#documentation": "The resolved attributes specific to the problem type of an AutoML job V2.
" } }, "com.amazonaws.sagemaker#AutoMLProcessingUnit": { @@ -3225,6 +3268,26 @@ } } }, + "com.amazonaws.sagemaker#AutoMLResolvedAttributes": { + "type": "structure", + "members": { + "AutoMLJobObjective": { + "target": "com.amazonaws.sagemaker#AutoMLJobObjective" + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "AutoMLProblemTypeResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeResolvedAttributes", + "traits": { + "smithy.api#documentation": "Defines the resolved attributes specific to a problem type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes used to configure an AutoML job V2.
" + } + }, "com.amazonaws.sagemaker#AutoMLS3DataSource": { "type": "structure", "members": { @@ -3356,7 +3419,7 @@ } }, "traits": { - "smithy.api#documentation": "The name and an example value of the hyperparameter that\n you want to use in Autotune. If Automatic model tuning (AMT) determines that your hyperparameter is eligible\n for Autotune, an optimal hyperparameter range is selected for you.
" + "smithy.api#documentation": "The name and an example value of the hyperparameter that you want to use in Autotune.\n If Automatic model tuning (AMT) determines that your hyperparameter is eligible for\n Autotune, an optimal hyperparameter range is selected for you.
" } }, "com.amazonaws.sagemaker#AutoParameters": { @@ -3397,7 +3460,7 @@ } }, "traits": { - "smithy.api#documentation": "A flag to indicate if you want to use Autotune to automatically find optimal values for\n the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a hyperparameter\n tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a training job.\n These resources include the maximum number of training jobs, the maximum runtime of a\n tuning job, and the maximum number of training jobs to run at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not to use\n early stopping for training jobs launched by a hyperparameter tuning job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the combinations of\n hyperparameter values to use for the training jobs that it launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model\n convergence.
\nA flag to indicate if you want to use Autotune to automatically find optimal values\n for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nStores the configuration information for the selection of algorithms used to train model\n candidates on tabular data.
\nThe list of available algorithms to choose from depends on the training mode set in\n \n TabularJobConfig.Mode\n .
\n AlgorithmsConfig should not be set in AUTO training\n mode.
When AlgorithmsConfig is provided, one AutoMLAlgorithms\n attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms is\n empty, CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
When AlgorithmsConfig is not provided,\n CandidateGenerationConfig uses the full set of algorithms for the\n given training mode.
For the list of all algorithms per problem type and training mode, see \n AutoMLAlgorithmConfig.
\nFor more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores the configuration information for how model candidates are generated using an\n AutoML job V2.
" + } + }, "com.amazonaws.sagemaker#CandidateName": { "type": "string", "traits": { @@ -4336,7 +4413,7 @@ "InputMode": { "target": "com.amazonaws.sagemaker#TrainingInputMode", "traits": { - "smithy.api#documentation": "(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification \n request when you have a channel that needs a different input mode from the training\n job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML\n storage volume, and mount the directory to a Docker volume, use File input\n mode. To stream data directly from Amazon S3 to the container, choose Pipe input\n mode.
To use a model for incremental training, choose File input model.
(Optional) The input mode to use for the data channel in a training job. If you don't\n set a value for InputMode, SageMaker uses the value set for\n TrainingInputMode. Use this parameter to override the\n TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a\n different input mode from the training job's general setting. To download the data from\n Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a\n Docker volume, use File input mode. To stream data directly from Amazon S3 to\n the container, choose Pipe input mode.
To use a model for incremental training, choose File input model.
The allowed input mode, either FILE or PIPE.
\nIn FILE mode, Amazon SageMaker copies the data from the input source onto the local\n Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm.\n This is the most commonly used input mode.
\nIn PIPE mode, Amazon SageMaker streams input data from the source directly to your\n algorithm without using the EBS volume.
", + "smithy.api#documentation": "The allowed input mode, either FILE or PIPE.
\nIn FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon\n Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This\n is the most commonly used input mode.
\nIn PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm\n without using the EBS volume.
", "smithy.api#required": {} } } @@ -5873,13 +5950,13 @@ "Image": { "target": "com.amazonaws.sagemaker#ContainerImage", "traits": { - "smithy.api#documentation": "The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.\n
The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nThe path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a\n Docker registry that is accessible from the same VPC that you configure for your\n endpoint. If you are using your own custom algorithm instead of an algorithm provided by\n SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nSpecifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.\n
\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nSpecifies whether the model container is in Amazon ECR or a private Docker registry\n accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a\n private Docker registry, see Use a\n Private Docker Registry for Real-Time Inference Containers.
\nThe model artifacts in an Amazon S3 bucket and the Docker image for inference container\n in Amazon EC2 Container Registry must be in the same region as the model or endpoint you are\n creating.
\nCreates an Autopilot job.
\nFind the best-performing model after you run an Autopilot job by calling DescribeAutoMLJob.
\nFor information about how to use Autopilot, see Automate Model\n Development with Amazon SageMaker Autopilot.
" + "smithy.api#documentation": "Creates an Autopilot job also referred to as Autopilot experiment or AutoML job.
\nFind the best-performing model after you run an AutoML job by calling DescribeAutoMLJobV2 (recommended) or DescribeAutoMLJob.
\n\n CreateAutoMLJob only accepts tabular input data. We recommend using\n CreateAutoMLJobV2 for all problem types. CreateAutoMLJobV2 can\n process the same tabular data as its previous version CreateAutoMLJob, as\n well as non-tabular data for problem types such as image or text classification.
Find guidelines about how to migrate CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
Defines the objective metric used to measure the predictive quality of an AutoML job. You\n provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize\n it. For CreateAutoMLJobV2, only Accuracy is supported.
Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. See AutoMLJobObjective for the default values.
" } }, "AutoMLJobConfig": { @@ -6739,7 +6816,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon SageMaker AutoML job that uses non-tabular data such as images or text for\n Computer Vision or Natural Language Processing problems.
\nFind the resulting model after you run an AutoML job V2 by calling DescribeAutoMLJobV2.
\nTo create an AutoMLJob using tabular data, see CreateAutoMLJob.
This API action is callable through SageMaker Canvas only. Calling it directly from the CLI\n or an SDK results in an error.
\nCreates an Autopilot job also referred to as Autopilot experiment or AutoML job V2.
\nWe recommend using CreateAutoMLJobV2\n for all problem types. CreateAutoMLJobV2 can process the same tabular data as\n its previous version CreateAutoMLJob, as well as non-tabular data for problem\n types such as image or text classification.
Find guidelines about how to migrate CreateAutoMLJob to\n CreateAutoMLJobV2 in Migrate a CreateAutoMLJob to CreateAutoMLJobV2.
For the list of available problem types supported by CreateAutoMLJobV2, see\n AutoMLProblemTypeConfig.
Find the best-performing model after you run an AutoML job V2 by calling DescribeAutoMLJobV2. Calling DescribeAutoMLJob\n on a AutoML job V2 results in an error.
" } }, "com.amazonaws.sagemaker#CreateAutoMLJobV2Request": { @@ -6755,7 +6832,7 @@ "AutoMLJobInputDataConfig": { "target": "com.amazonaws.sagemaker#AutoMLJobInputDataConfig", "traits": { - "smithy.api#documentation": "An array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported\n formats depend on the problem type:
ImageClassification: S3Prefix, ManifestFile,\n AugmentedManifestFile\n
TextClassification: S3Prefix
\nAn array of channel objects describing the input data and their location. Each channel\n is a named input source. Similar to InputDataConfig supported by CreateAutoMLJob. The supported\n formats depend on the problem type:
For Tabular problem types: S3Prefix,\n ManifestFile.
For ImageClassification: S3Prefix, ManifestFile,\n AugmentedManifestFile.
For TextClassification: S3Prefix.
Defines the configuration settings of one of the supported problem types.
", + "smithy.api#documentation": "Defines the configuration settings of one of the supported problem types.
\nFor tabular problem types, you must either specify the type of supervised learning\n problem in AutoMLProblemTypeConfig\n (TabularJobConfig.ProblemType) and provide the\n AutoMLJobObjective, or none at all.
Specifies a metric to minimize or maximize as the objective of a job. For CreateAutoMLJobV2, only Accuracy is supported.
Specifies a metric to minimize or maximize as the objective of a job. If not specified,\n the default objective metric depends on the problem type. For the list of default values\n per problem type, see AutoMLJobObjective.
\nFor tabular problem types, you must either provide the\n AutoMLJobObjective and indicate the type of supervised learning problem\n in AutoMLProblemTypeConfig (TabularJobConfig.ProblemType), or\n none.
This structure specifies how to split the data into train and validation\n datasets.
\nIf you are using the V1 API (for example CreateAutoMLJob) or the V2 API for\n Natural Language Processing problems (for example CreateAutoMLJobV2 with a\n TextClassificationJobConfig problem type), the validation and training\n datasets must contain the same headers. Also, for V1 API jobs, the validation dataset must\n be less than 2 GB in size.
This structure specifies how to split the data into train and validation\n datasets.
\nThe validation and training datasets must contain the same headers. For jobs created by\n calling CreateAutoMLJob, the validation dataset must be less than 2 GB in\n size.
The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to Service.
The entity that creates and manages the required security groups for inter-app\n communication in VPCOnly mode. Required when\n CreateDomain.AppNetworkAccessType is VPCOnly and\n DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is\n provided. If setting up the domain for use with RStudio, this value must be set to\n Service.
Creates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\nFor an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n
\n You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint\n API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to\n the role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint using the endpoint configuration specified in the request. SageMaker\n uses the endpoint to provision resources and deploy models. You create the endpoint\n configuration with the CreateEndpointConfig API.
\nUse this API to deploy models using SageMaker hosting services.
\nFor an example that calls this method when deploying a model to SageMaker hosting services,\n see the Create Endpoint example notebook.\n
\n You must not delete an EndpointConfig that is in use by an endpoint\n that is live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
The endpoint name must be unique within an Amazon Web Services Region in your\n Amazon Web Services account.
\nWhen it receives the request, SageMaker creates the endpoint, launches the resources (ML\n compute instances), and deploys the model(s) on them.
\nWhen you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to\n Creating. After it creates the endpoint, it sets the status to\n InService. SageMaker can then process incoming requests for inferences. To\n check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location,\n SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the\n S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services\n account by default. If you previously deactivated Amazon Web Services STS for a region,\n you need to reactivate Amazon Web Services STS for that region. For more information, see\n Activating and\n Deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Amazon Web Services Identity and Access Management User\n Guide.
\nTo add the IAM role policies for using this API operation, go to the IAM console, and choose\n Roles in the left navigation pane. Search the IAM role that you want to grant\n access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the\n role.
\nOption 1: For a full SageMaker access, search and attach the\n AmazonSageMakerFullAccess policy.
Option 2: For granting a limited access to an IAM role, paste the\n following Action elements manually into the JSON file of the IAM role:
\n\n \"Action\": [\"sagemaker:CreateEndpoint\",\n \"sagemaker:CreateEndpointConfig\"]\n
\n \"Resource\": [\n
\n \"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"\n
\n \"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"\n
\n ]\n
For more information, see SageMaker API\n Permissions: Actions, Permissions, and Resources\n Reference.
\nCreates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into\n production.
\nIn the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.
When you call CreateEndpoint, a load call is made to DynamoDB to\n verify that your endpoint configuration exists. When you read data from a DynamoDB\n table supporting \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In\n the configuration, you identify one or more models, created using the\n CreateModel API, to deploy and the resources that you want SageMaker to\n provision. Then you call the CreateEndpoint\n API.
Use this API if you want to use SageMaker hosting services to deploy models into\n production.
\nIn the request, you define a ProductionVariant, for each model that you\n want to deploy. Each ProductionVariant parameter also describes the\n resources that you want SageMaker to provision. This includes the number and type of ML\n compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight to\n specify how much traffic you want to allocate to each model. For example, suppose that\n you want to host two models, A and B, and you assign traffic weight 2 for model A and 1\n for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to\n model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your\n endpoint configuration exists. When you read data from a DynamoDB table supporting\n \n Eventually Consistent Reads\n , the response might not\n reflect the results of a recently completed write operation. The response might\n include some stale data. If the dependent entities are not yet in DynamoDB, this\n causes a validation error. If you repeat your read request after a short time, the\n response should return the latest data. So retry logic is recommended to handle\n these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB\n eventually consistent read.
The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The name of the endpoint.The name must be unique within an Amazon Web Services\n Region in your Amazon Web Services account. The name is case-insensitive in\n CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
The HyperParameterTuningJobConfig object that describes the tuning\n job, including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.
", + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that describes the tuning job,\n including the search strategy, the objective metric used to evaluate training jobs,\n ranges of parameters to search, and resource limits for the tuning job. For more\n information, see How\n Hyperparameter Tuning Works.
", "smithy.api#required": {} } }, "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the\n training jobs that this tuning job launches, including static hyperparameters, input\n data configuration, output data configuration, resource configuration, and stopping\n condition.
" + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that describes the training jobs\n that this tuning job launches, including static hyperparameters, input data\n configuration, output data configuration, resource configuration, and stopping\n condition.
" } }, "TrainingJobDefinitions": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched\n for this tuning job.
" + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" } }, "WarmStartConfig": { @@ -8158,7 +8235,7 @@ "Autotune": { "target": "com.amazonaws.sagemaker#Autotune", "traits": { - "smithy.api#documentation": "Configures SageMaker Automatic model tuning (AMT) to automatically find optimal parameters\n for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a hyperparameter\n tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a training job.\n These resources include the maximum number of training jobs, the maximum runtime of a\n tuning job, and the maximum number of training jobs to run at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not to use\n early stopping for training jobs launched by a hyperparameter tuning job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the combinations of\n hyperparameter values to use for the training jobs that it launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning (AMT) has detected model\n convergence.
\nConfigures SageMaker Automatic model tuning (AMT) to automatically find optimal\n parameters for the following fields:
\n\n ParameterRanges: The names and ranges of parameters that a\n hyperparameter tuning job can optimize.
\n\n ResourceLimits: The maximum resources that can be used for a\n training job. These resources include the maximum number of training jobs, the\n maximum runtime of a tuning job, and the maximum number of training jobs to run\n at the same time.
\n\n TrainingJobEarlyStoppingType: A flag that specifies whether or not\n to use early stopping for training jobs launched by a hyperparameter tuning\n job.
\n\n RetryStrategy: The number of times to retry a training job.
\n\n Strategy: Specifies how hyperparameter tuning chooses the\n combinations of hyperparameter values to use for the training jobs that it\n launches.
\n\n ConvergenceDetected: A flag to indicate that Automatic model tuning\n (AMT) has detected model convergence.
\nA VpcConfig object that specifies the VPC that you want your model\n to connect to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.
A VpcConfig object that specifies the VPC that you want your model to connect\n to. Control access to and from your model container by configuring the VPC.\n VpcConfig is used in hosting services and in batch transform. For more\n information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch\n Transform Jobs by Using an Amazon Virtual Private Cloud.
Returns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If\n you try to use the URL after the 5-minute limit expires, you are directed to the\n Amazon Web Services console sign-in page.
\nReturns a URL that you can use to connect to the Jupyter server from a notebook\n instance. In the SageMaker console, when you choose Open next to a notebook\n instance, SageMaker opens a new tab showing the Jupyter server home page from the notebook\n instance. The console uses this API to get the URL and show the page.
The IAM role or user used to call this API defines the permissions to access the\n notebook instance. Once the presigned URL is created, no additional permission is\n required to access this URL. IAM authorization policies for this API are also enforced\n for every HTTP request and WebSocket frame that attempts to connect to the notebook\n instance.
\nYou can restrict access to this API and to the URL that it returns to a list of IP\n addresses that you specify. Use the NotIpAddress condition operator and the\n aws:SourceIP condition context key to specify the list of IP addresses\n that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.
The URL that you get from a call to CreatePresignedNotebookInstanceUrl is valid only for 5 minutes. If you\n try to use the URL after the 5-minute limit expires, you are directed to the Amazon Web Services console sign-in page.
\nThe registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.\n
", + "smithy.api#documentation": "The registry path of the Docker image that contains the training algorithm and\n algorithm-specific metadata, including the input mode. For more information about\n algorithms provided by SageMaker, see Algorithms. For information about\n providing your own algorithms, see Using Your Own Algorithms with\n Amazon SageMaker.
", "smithy.api#required": {} } }, @@ -10305,7 +10382,7 @@ "InputDataConfig": { "target": "com.amazonaws.sagemaker#InputDataConfig", "traits": { - "smithy.api#documentation": "An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.
\nYour input must be in the same Amazon Web Services region as your training job.
" + "smithy.api#documentation": "An array of Channel objects. Each channel is a named input source.\n InputDataConfig describes the input data and its location.
Algorithms can accept input data from one or more channels. For example, an\n algorithm might have two channels of input data, training_data and\n validation_data. The configuration for each channel provides the S3,\n EFS, or FSx location where the input data is stored. It also provides information about\n the stored data: the MIME type, compression method, and whether the data is wrapped in\n RecordIO format.
Depending on the input mode that the algorithm supports, SageMaker either copies input\n data files from an S3 bucket to a local directory in the Docker container, or makes it\n available as input streams. For example, if you specify an EFS location, input data\n files are available as input streams. They do not need to be downloaded.
\nYour input must be in the same Amazon Web Services region as your training\n job.
" } }, "OutputDataConfig": { @@ -10325,7 +10402,7 @@ "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your\n training job to connect to. Control access to and from your training container by\n configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that you want your training job to\n connect to. Control access to and from your training container by configuring the VPC.\n For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" } }, "StoppingCondition": { @@ -14059,7 +14136,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about an Amazon SageMaker AutoML job.
" + "smithy.api#documentation": "Returns information about an AutoML job created by calling CreateAutoMLJob.
" } }, "com.amazonaws.sagemaker#DescribeAutoMLJobRequest": { @@ -14201,7 +14278,7 @@ "ResolvedAttributes": { "target": "com.amazonaws.sagemaker#ResolvedAttributes", "traits": { - "smithy.api#documentation": "Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n auto-inferred. If you do provide them, the values used are the ones you provide.
Contains ProblemType, AutoMLJobObjective, and\n CompletionCriteria. If you do not provide these values, they are\n inferred.
Returns information about an Amazon SageMaker AutoML V2 job.
\nThis API action is callable through SageMaker Canvas only. Calling it directly from the CLI\n or an SDK results in an error.
\nReturns information about an AutoML job V2 created by calling CreateAutoMLJobV2.
" } }, "com.amazonaws.sagemaker#DescribeAutoMLJobV2Request": { @@ -14244,7 +14321,7 @@ "AutoMLJobName": { "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { - "smithy.api#documentation": "Requests information about an AutoML V2 job using its unique name.
", + "smithy.api#documentation": "Requests information about an AutoML job V2 using its unique name.
", "smithy.api#required": {} } } @@ -14259,14 +14336,14 @@ "AutoMLJobName": { "target": "com.amazonaws.sagemaker#AutoMLJobName", "traits": { - "smithy.api#documentation": "Returns the name of the AutoML V2 job.
", + "smithy.api#documentation": "Returns the name of the AutoML job V2.
", "smithy.api#required": {} } }, "AutoMLJobArn": { "target": "com.amazonaws.sagemaker#AutoMLJobArn", "traits": { - "smithy.api#documentation": "Returns the Amazon Resource Name (ARN) of the AutoML V2 job.
", + "smithy.api#documentation": "Returns the Amazon Resource Name (ARN) of the AutoML job V2.
", "smithy.api#required": {} } }, @@ -14300,20 +14377,20 @@ "AutoMLProblemTypeConfig": { "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfig", "traits": { - "smithy.api#documentation": "Returns the configuration settings of the problem type set for the AutoML V2 job.
" + "smithy.api#documentation": "Returns the configuration settings of the problem type set for the AutoML job V2.
" } }, "CreationTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Returns the creation time of the AutoML V2 job.
", + "smithy.api#documentation": "Returns the creation time of the AutoML job V2.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { - "smithy.api#documentation": "Returns the end time of the AutoML V2 job.
" + "smithy.api#documentation": "Returns the end time of the AutoML job V2.
" } }, "LastModifiedTime": { @@ -14326,13 +14403,13 @@ "FailureReason": { "target": "com.amazonaws.sagemaker#AutoMLFailureReason", "traits": { - "smithy.api#documentation": "Returns the reason for the failure of the AutoML V2 job, when applicable.
" + "smithy.api#documentation": "Returns the reason for the failure of the AutoML job V2, when applicable.
" } }, "PartialFailureReasons": { "target": "com.amazonaws.sagemaker#AutoMLPartialFailureReasons", "traits": { - "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML V2 job.
" + "smithy.api#documentation": "Returns a list of reasons for partial failures within an AutoML job V2.
" } }, "BestCandidate": { @@ -14344,14 +14421,14 @@ "AutoMLJobStatus": { "target": "com.amazonaws.sagemaker#AutoMLJobStatus", "traits": { - "smithy.api#documentation": "Returns the status of the AutoML V2 job.
", + "smithy.api#documentation": "Returns the status of the AutoML job V2.
", "smithy.api#required": {} } }, "AutoMLJobSecondaryStatus": { "target": "com.amazonaws.sagemaker#AutoMLJobSecondaryStatus", "traits": { - "smithy.api#documentation": "Returns the secondary status of the AutoML V2 job.
", + "smithy.api#documentation": "Returns the secondary status of the AutoML job V2.
", "smithy.api#required": {} } }, @@ -14378,6 +14455,21 @@ "traits": { "smithy.api#documentation": "Returns the security configuration for traffic encryption or Amazon VPC settings.
" } + }, + "AutoMLJobArtifacts": { + "target": "com.amazonaws.sagemaker#AutoMLJobArtifacts" + }, + "ResolvedAttributes": { + "target": "com.amazonaws.sagemaker#AutoMLResolvedAttributes", + "traits": { + "smithy.api#documentation": "Returns the resolved attributes used by the AutoML job V2.
" + } + }, + "AutoMLProblemTypeConfigName": { + "target": "com.amazonaws.sagemaker#AutoMLProblemTypeConfigName", + "traits": { + "smithy.api#documentation": "Returns the name of the problem type configuration set for the AutoML job V2.
" + } } }, "traits": { @@ -15586,7 +15678,7 @@ "KmsKeyId": { "target": "com.amazonaws.sagemaker#KmsKeyId", "traits": { - "smithy.api#documentation": "Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on\n the ML storage volume attached to the instance.
" + "smithy.api#documentation": "Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML\n storage volume attached to the instance.
" } }, "CreationTime": { @@ -15661,7 +15753,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#ProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model\n hosted behind this endpoint.
" + "smithy.api#documentation": "An array of ProductionVariantSummary objects, one for each model hosted behind this\n endpoint.
" } }, "DataCaptureConfig": { @@ -15670,7 +15762,7 @@ "EndpointStatus": { "target": "com.amazonaws.sagemaker#EndpointStatus", "traits": { - "smithy.api#documentation": "The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use the \n FailureReason value returned by DescribeEndpoint for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n the FailureReason value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
An array of ProductionVariantSummary objects, one for each model\n that you want to host at this endpoint in shadow mode with production traffic replicated\n from the model specified on ProductionVariants.
An array of ProductionVariantSummary objects, one for each model that you want to host\n at this endpoint in shadow mode with production traffic replicated from the model\n specified on ProductionVariants.
The HyperParameterTuningJobConfig object that specifies the\n configuration of the tuning job.
", + "smithy.api#documentation": "The HyperParameterTuningJobConfig object that specifies the configuration of\n the tuning job.
", "smithy.api#required": {} } }, "TrainingJobDefinition": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinition", "traits": { - "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the\n definition of the training jobs that this tuning job launches.
" + "smithy.api#documentation": "The HyperParameterTrainingJobDefinition object that specifies the definition of\n the training jobs that this tuning job launches.
" } }, "TrainingJobDefinitions": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobDefinitions", "traits": { - "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched\n for this tuning job.
" + "smithy.api#documentation": "A list of the HyperParameterTrainingJobDefinition objects launched for this tuning\n job.
" } }, "HyperParameterTuningJobStatus": { @@ -16627,27 +16719,27 @@ "TrainingJobStatusCounters": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", "traits": { - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of\n training jobs, categorized by status, that this tuning job launched.
", + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the number of training\n jobs, categorized by status, that this tuning job launched.
", "smithy.api#required": {} } }, "ObjectiveStatusCounters": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", "traits": { - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of\n training jobs, categorized by the status of their final objective metric, that this\n tuning job launched.
", + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the number of training jobs,\n categorized by the status of their final objective metric, that this tuning job\n launched.
", "smithy.api#required": {} } }, "BestTrainingJob": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that\n completed with the best current HyperParameterTuningJobObjective.
" + "smithy.api#documentation": "A TrainingJobSummary object that describes the training job that completed\n with the best current HyperParameterTuningJobObjective.
" } }, "OverallBestTrainingJob": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobSummary", "traits": { - "smithy.api#documentation": "If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective\n metric value of all training jobs launched by this tuning job and all parent jobs\n specified for the warm start tuning job.
If the hyperparameter tuning job is an warm start tuning job with a\n WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the\n TrainingJobSummary for the training job with the best objective metric\n value of all training jobs launched by this tuning job and all parent jobs specified for\n the warm start tuning job.
A VpcConfig object that specifies the VPC that this model has access\n to. For more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this model has access to. For\n more information, see Protect Endpoints by Using an Amazon Virtual\n Private Cloud\n
" } }, "CreationTime": { @@ -18889,7 +18981,7 @@ "AcceleratorTypes": { "target": "com.amazonaws.sagemaker#NotebookInstanceAcceleratorTypes", "traits": { - "smithy.api#documentation": "A list of the Elastic Inference (EI) instance types associated with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon SageMaker.
" + "smithy.api#documentation": "A list of the Elastic Inference (EI) instance types associated with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in\n Amazon SageMaker.
" } }, "DefaultCodeRepository": { @@ -19111,7 +19203,7 @@ "PipelineName": { "target": "com.amazonaws.sagemaker#PipelineNameOrArn", "traits": { - "smithy.api#documentation": "The name of the pipeline to describe.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline to describe.
", "smithy.api#required": {} } } @@ -19919,7 +20011,7 @@ "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" } }, "StoppingCondition": { @@ -21556,7 +21648,7 @@ "RStudioServerProDomainSettingsForUpdate": { "target": "com.amazonaws.sagemaker#RStudioServerProDomainSettingsForUpdate", "traits": { - "smithy.api#documentation": "A collection of RStudioServerPro Domain-level app settings to\n update. A single RStudioServerPro application is created for a domain.
A collection of RStudioServerPro Domain-level app settings to update. A\n single RStudioServerPro application is created for a domain.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about\n the failure. DeleteEndpoint is the only operation that can be\n performed on a failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.
The status of the endpoint.
\n\n OutOfService: Endpoint is not available to take incoming\n requests.
\n Creating: CreateEndpoint is executing.
\n Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
\n SystemUpdating: Endpoint is undergoing maintenance and cannot be\n updated or deleted or re-scaled until it has completed. This maintenance\n operation does not change any customer-specified values such as VPC config, KMS\n encryption, model, instance type, or instance count.
\n RollingBack: Endpoint fails to scale up or down or change its\n variant weight and is in the process of rolling back to its previous\n configuration. Once the rollback completes, endpoint returns to an\n InService status. This transitional status only applies to an\n endpoint that has autoscaling enabled and is undergoing variant weight or\n capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called\n explicitly.
\n InService: Endpoint is available to process incoming\n requests.
\n Deleting: DeleteEndpoint is executing.
\n Failed: Endpoint could not be created, updated, or re-scaled. Use\n DescribeEndpointOutput$FailureReason for information about the\n failure. DeleteEndpoint is the only operation that can be performed on a\n failed endpoint.
To get a list of endpoints with a specified status, use the StatusEquals\n filter with a call to ListEndpoints.
Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
Shows the latest objective metric emitted by a training job that was launched by a\n hyperparameter tuning job. You define the objective metric in the\n HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.
The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
The registry path of the Docker image that contains the training algorithm. For\n information about Docker registry paths for built-in algorithms, see Algorithms\n Provided by Amazon SageMaker: Common Parameters. SageMaker supports both\n registry/repository[:tag] and registry/repository[@digest]\n image path formats. For more information, see Using Your Own Algorithms with\n Amazon SageMaker.
An array of Channel objects that specify\n the\n input for the training jobs that the tuning job launches.
" + "smithy.api#documentation": "An array of Channel objects that\n specify\n the\n input for the training jobs that the tuning job launches.
" } }, "VpcConfig": { "target": "com.amazonaws.sagemaker#VpcConfig", "traits": { - "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the\n training jobs that this hyperparameter tuning job launches to connect to. Control access\n to and from your training container by configuring the VPC. For more information, see\n Protect\n Training Jobs by Using an Amazon Virtual Private Cloud.
" + "smithy.api#documentation": "The VpcConfig object that specifies the VPC that you want the training jobs\n that this hyperparameter tuning job launches to connect to. Control access to and from\n your training container by configuring the VPC. For more information, see Protect Training Jobs\n by Using an Amazon Virtual Private Cloud.
" } }, "OutputDataConfig": { @@ -25799,7 +25891,7 @@ "Environment": { "target": "com.amazonaws.sagemaker#HyperParameterTrainingJobEnvironmentMap", "traits": { - "smithy.api#documentation": "An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics\n and variables for more information.
\nThe maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.
An environment variable that you can pass into the SageMaker CreateTrainingJob API. You can use an existing environment variable from the training container or use your own. See\n Define metrics and variables for more information.
\nThe maximum number of items specified for Map Entries refers to the\n maximum number of environment variables for each TrainingJobDefinition\n and also the maximum for the hyperparameter tuning job itself. That is, the sum of\n the number of environment variables for all the training job definitions can't\n exceed the maximum number specified.
The FinalHyperParameterTuningJobObjectiveMetric object that\n specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.
" + "smithy.api#documentation": "The FinalHyperParameterTuningJobObjectiveMetric object that specifies the\n value\n of the\n objective\n metric of the tuning job that launched this training job.
" } }, "ObjectiveStatus": { @@ -25980,7 +26072,7 @@ "target": "com.amazonaws.sagemaker#TrainingInstanceCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See SageMaker distributed training\n jobs for more information.
The number of instances of the type specified by InstanceType. Choose an\n instance count larger than 1 for distributed training algorithms. See Step 2:\n Launch a SageMaker Distributed Training Job Using the SageMaker Python SDK for more information.
The HyperParameterTuningJobObjective specifies the objective metric\n used to evaluate the performance of training jobs launched by this tuning job.
" + "smithy.api#documentation": "The HyperParameterTuningJobObjective specifies the objective metric used to\n evaluate the performance of training jobs launched by this tuning job.
" } }, "ResourceLimits": { "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "The ResourceLimits object that specifies the maximum number of\n training and parallel training jobs that can be used for this hyperparameter tuning\n job.
", + "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training and parallel training jobs that can\n be used for this hyperparameter tuning job.
", "smithy.api#required": {} } }, "ParameterRanges": { "target": "com.amazonaws.sagemaker#ParameterRanges", "traits": { - "smithy.api#documentation": "The ParameterRanges object that specifies the ranges of\n hyperparameters that this tuning job searches over to find the optimal configuration for\n the highest model performance against your chosen objective metric.
" + "smithy.api#documentation": "The ParameterRanges\n object that specifies the ranges of hyperparameters that this tuning job searches over\n to find the optimal configuration for the highest model performance against your chosen\n objective metric.
" } }, "TrainingJobEarlyStoppingType": { @@ -26426,21 +26518,21 @@ "TrainingJobStatusCounters": { "target": "com.amazonaws.sagemaker#TrainingJobStatusCounters", "traits": { - "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of\n training jobs, categorized by status, that this tuning job launched.
", + "smithy.api#documentation": "The TrainingJobStatusCounters object that specifies the numbers of training\n jobs, categorized by status, that this tuning job launched.
", "smithy.api#required": {} } }, "ObjectiveStatusCounters": { "target": "com.amazonaws.sagemaker#ObjectiveStatusCounters", "traits": { - "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of\n training jobs, categorized by objective metric status, that this tuning job\n launched.
", + "smithy.api#documentation": "The ObjectiveStatusCounters object that specifies the numbers of training jobs,\n categorized by objective metric status, that this tuning job launched.
", "smithy.api#required": {} } }, "ResourceLimits": { "target": "com.amazonaws.sagemaker#ResourceLimits", "traits": { - "smithy.api#documentation": "The ResourceLimits object that specifies the maximum number of\n training jobs and parallel training jobs allowed for this tuning job.
" + "smithy.api#documentation": "The ResourceLimits\n object that specifies the maximum number of training jobs and parallel training jobs\n allowed for this tuning job.
" } } }, @@ -26502,7 +26594,7 @@ "InstanceType": { "target": "com.amazonaws.sagemaker#TrainingInstanceType", "traits": { - "smithy.api#documentation": "The instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.
" + "smithy.api#documentation": "The instance type used to run hyperparameter optimization tuning jobs. See descriptions of\n instance types for more information.
" } }, "InstanceCount": { @@ -26730,7 +26822,7 @@ } }, "traits": { - "smithy.api#documentation": "Stores the configuration information for the image classification problem of an AutoML\n job using the V2 API.
" + "smithy.api#documentation": "Stores the configuration information for the image classification problem of an AutoML\n job V2.
" } }, "com.amazonaws.sagemaker#ImageConfig": { @@ -29755,7 +29847,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of AppImageConfigs to return in the response. The default value is\n 10.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
Returns a list up to a specified limit.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
Returns a list up to a specified limit.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
The name of the pipeline.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", "smithy.api#required": {} } }, @@ -35274,7 +35366,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "Returns a list up to a specified limit.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
The maximum number of Studio Lifecycle Configurations to return in the response. The default value is 10.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
A token for getting the next set of actions, if there are any.
" + "smithy.api#documentation": "If the previous response was truncated, you will receive this token.\n Use it in your next request to receive the next set of results.
" } }, "StudioLifecycleConfigs": { @@ -35688,7 +35780,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a list of TrainingJobSummary objects that describe the training\n jobs that a hyperparameter tuning job launched.
", + "smithy.api#documentation": "Gets a list of TrainingJobSummary objects that describe the training jobs that a\n hyperparameter tuning job launched.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -36205,7 +36297,7 @@ "MaxResults": { "target": "com.amazonaws.sagemaker#MaxResults", "traits": { - "smithy.api#documentation": "Returns a list up to a specified limit.
" + "smithy.api#documentation": "The total number of items to return in the response. If the total\n number of items available is more than the value specified, a NextToken\n is provided in the response. To resume pagination, provide the NextToken\n value in the as part of a subsequent call. The default value is 10.
A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining\n metrics and environment variables.
", + "smithy.api#documentation": "A regular expression that searches the output of a training job and gets the value of\n the metric. For more information about using regular expressions to define metrics, see\n Defining metrics and environment variables.
", "smithy.api#required": {} } } @@ -41549,7 +41641,7 @@ "TargetDevice": { "target": "com.amazonaws.sagemaker#TargetDevice", "traits": { - "smithy.api#documentation": "Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform fields. It can be\n used instead of TargetPlatform.
Identifies the target device or the machine learning instance that you want to run\n your model on after the compilation has completed. Alternatively, you can specify OS,\n architecture, and accelerator using TargetPlatform fields. It can be\n used instead of TargetPlatform.
Currently ml_trn1 is available only in US East (N. Virginia) Region,\n and ml_inf2 is available only in US East (Ohio) Region.
The array of IntegerParameterRange objects that specify ranges of\n integer hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of IntegerParameterRange objects that specify ranges of integer\n hyperparameters that a hyperparameter tuning job searches.
" } }, "ContinuousParameterRanges": { "target": "com.amazonaws.sagemaker#ContinuousParameterRanges", "traits": { - "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of\n continuous hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of ContinuousParameterRange objects that specify ranges of continuous\n hyperparameters that a hyperparameter tuning job searches.
" } }, "CategoricalParameterRanges": { "target": "com.amazonaws.sagemaker#CategoricalParameterRanges", "traits": { - "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges\n of categorical hyperparameters that a hyperparameter tuning job searches.
" + "smithy.api#documentation": "The array of CategoricalParameterRange objects that specify ranges of categorical\n hyperparameters that a hyperparameter tuning job searches.
" } }, "AutoParameters": { "target": "com.amazonaws.sagemaker#AutoParameters", "traits": { - "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to determine optimal ranges for your tuning job.
" + "smithy.api#documentation": "A list containing hyperparameter names and example values to be used by Autotune to\n determine optimal ranges for your tuning job.
" } } }, @@ -41884,7 +41976,7 @@ "ProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each\n model hosted behind this endpoint for the in-progress deployment.
" + "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint for the in-progress deployment.
" } }, "StartTime": { @@ -41896,7 +41988,7 @@ "ShadowProductionVariants": { "target": "com.amazonaws.sagemaker#PendingProductionVariantSummaryList", "traits": { - "smithy.api#documentation": "An array of PendingProductionVariantSummary objects, one for each\n model hosted behind this endpoint in shadow mode with production traffic replicated from\n the model specified on ProductionVariants for the in-progress\n deployment.
An array of PendingProductionVariantSummary objects, one for each model hosted behind\n this endpoint in shadow mode with production traffic replicated from the model specified\n on ProductionVariants for the in-progress deployment.
The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint or UpdateEndpoint operations. Describes the VariantStatus\n , weight and capacity for a production variant associated with an endpoint.\n
The production variant summary for a deployment when an endpoint is creating or\n updating with the CreateEndpoint\n or UpdateEndpoint\n operations. Describes the VariantStatus , weight and capacity for a\n production variant associated with an endpoint.
The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.
" + "smithy.api#documentation": "The size of the Elastic Inference (EI) instance to use for the production variant. EI\n instances provide on-demand GPU computing for inference. For more information, see\n Using Elastic\n Inference in Amazon SageMaker.
" } }, "CoreDumpConfig": { @@ -43805,12 +43897,12 @@ "EnableSSMAccess": { "target": "com.amazonaws.sagemaker#ProductionVariantSSMAccess", "traits": { - "smithy.api#documentation": "\n You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.\n
You can use this parameter to turn on native Amazon Web Services Systems Manager (SSM)\n access for a production variant behind an endpoint. By default, SSM access is disabled\n for all production variants behind an endpoint. You can turn on or turn off SSM access\n for a production variant behind an existing endpoint by creating a new endpoint\n configuration and calling UpdateEndpoint.
\n Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check \n Production variants.\n
" + "smithy.api#documentation": "Identifies a model that you want to host and the resources chosen to deploy for\n hosting it. If you are deploying multiple models, tell SageMaker how to distribute traffic\n among the models by specifying variant weights. For more information on production\n variants, check Production variants.\n
" } }, "com.amazonaws.sagemaker#ProductionVariantAcceleratorType": { @@ -47628,7 +47720,7 @@ "S3Uri": { "target": "com.amazonaws.sagemaker#S3Uri", "traits": { - "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set\n of S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your training job.
", + "smithy.api#documentation": "Depending on the value specified for the S3DataType, identifies either\n a key name prefix or a manifest. For example:
A key name prefix might look like this:\n s3://bucketname/exampleprefix\n
A manifest might look like this:\n s3://bucketname/example.manifest\n
A manifest is an S3 object which is a JSON file consisting of an array of\n elements. The first element is a prefix which is followed by one or more\n suffixes. SageMaker appends the suffix elements to the prefix to get a full set of\n S3Uri. Note that the prefix must be a valid non-empty\n S3Uri that precludes users from specifying a manifest whose\n individual S3Uri is sourced from different S3 buckets.
The following code example shows a valid manifest format:
\n\n [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},\n
\n \"relative/path/to/custdata-1\",\n
\n \"relative/path/custdata-2\",\n
\n ...\n
\n \"relative/path/custdata-N\"\n
\n ]\n
This JSON is equivalent to the following S3Uri\n list:
\n s3://customer_bucket/some/prefix/relative/path/to/custdata-1\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-2\n
\n ...\n
\n s3://customer_bucket/some/prefix/relative/path/custdata-N\n
The complete set of S3Uri in this manifest is the input data\n for the channel for this data source. The object that each S3Uri\n points to must be readable by the IAM role that SageMaker uses to perform tasks on\n your behalf.
Your input bucket must be located in same Amazon Web Services region as your\n training job.
", "smithy.api#required": {} } }, @@ -47652,7 +47744,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the S3 data source.
\nYour input bucket must be in the same Amazon Web Services region as your training job.
" + "smithy.api#documentation": "Describes the S3 data source.
\nYour input bucket must be in the same Amazon Web Services region as your training\n job.
" } }, "com.amazonaws.sagemaker#S3DataType": { @@ -50166,12 +50258,12 @@ "StatusMessage": { "target": "com.amazonaws.sagemaker#StatusMessage", "traits": { - "smithy.api#documentation": "A detailed description of the progress within a secondary status.\n
\nSageMaker provides secondary statuses and status messages that apply to each of\n them:
\nStarting the training job.
\nLaunching requested ML\n instances.
\nInsufficient\n capacity error from EC2 while launching instances,\n retrying!
\nLaunched\n instance was unhealthy, replacing it!
\nPreparing the instances for training.
\nDownloading the training image.
\nTraining\n image download completed. Training in\n progress.
\nStatus messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.
\nTo have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For\n example, at the start of a training job, you might see the following:
\n TrainingJobStatus - InProgress
\n SecondaryStatus - Training
\n StatusMessage - Downloading the training image
A detailed description of the progress within a secondary status.\n
\nSageMaker provides secondary statuses and status messages that apply to each of\n them:
\nStarting the training job.
\nLaunching requested ML\n instances.
\nInsufficient\n capacity error from EC2 while launching instances,\n retrying!
\nLaunched\n instance was unhealthy, replacing it!
\nPreparing the instances for training.
\nDownloading the training image.
\nTraining\n image download completed. Training in\n progress.
\nStatus messages are subject to change. Therefore, we recommend not including them\n in code that programmatically initiates actions. For examples, don't use status\n messages in if statements.
\nTo have an overview of your training job's progress, view\n TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example,\n at the start of a training job, you might see the following:
\n TrainingJobStatus - InProgress
\n SecondaryStatus - Training
\n StatusMessage - Downloading the training image
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides\n additional details about a status that the training job has transitioned through. A\n training job can be in one of several states, for example, starting, downloading,\n training, or uploading. Within each state, there are a number of intermediate states.\n For example, within the starting state, SageMaker could be starting the training job or\n launching the ML instances. These transitional states are referred to as the job's\n secondary\n status.\n
An array element of SecondaryStatusTransitions for DescribeTrainingJob. It provides additional details about a status that the\n training job has transitioned through. A training job can be in one of several states,\n for example, starting, downloading, training, or uploading. Within each state, there are\n a number of intermediate states. For example, within the starting state, SageMaker could be\n starting the training job or launching the ML instances. These transitional states are\n referred to as the job's secondary\n status.\n
The Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services region as the\n algorithm.
\nThe Amazon S3 path where the model artifacts, which result from model training, are stored.\n This path must point to a single gzip compressed tar archive\n (.tar.gz suffix).
The model artifacts must be in an S3 bucket that is in the same Amazon Web Services\n region as the algorithm.
\nThe name of the pipeline.
", + "smithy.api#documentation": "The name or Amazon Resource Name (ARN) of the pipeline.
", "smithy.api#required": {} } }, @@ -52376,6 +52468,75 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" } }, + "com.amazonaws.sagemaker#TabularJobConfig": { + "type": "structure", + "members": { + "CandidateGenerationConfig": { + "target": "com.amazonaws.sagemaker#CandidateGenerationConfig", + "traits": { + "smithy.api#documentation": "The configuration information of how model candidates are generated.
" + } + }, + "CompletionCriteria": { + "target": "com.amazonaws.sagemaker#AutoMLJobCompletionCriteria" + }, + "FeatureSpecificationS3Uri": { + "target": "com.amazonaws.sagemaker#S3Uri", + "traits": { + "smithy.api#documentation": "A URL to the Amazon S3 data source containing selected features from the input data source to\n run an Autopilot job V2. 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 only supports the following data types: numeric,\n categorical, text, and datetime. In HPO mode,\n Autopilot can support numeric, categorical, text,\n datetime, and sequence.
If only FeatureDataTypes is provided, the column keys (col1,\n col2,..) should be a subset of the column names in the input data.
If both FeatureDataTypes and FeatureAttributeNames are\n provided, then the column keys should be a subset of the column names provided in\n FeatureAttributeNames.
The key name FeatureAttributeNames is fixed. The values listed in\n [\"col1\", \"col2\", ...] are case sensitive and should be a list of strings\n containing unique values that are a subset of the column names in the input data. The list\n of columns provided must not include the target column.
The method that Autopilot uses to train the data. You can either specify the mode manually\n or let Autopilot choose for you based on the dataset size by selecting AUTO. In\n AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than\n 100 MB, and HYPERPARAMETER_TUNING for larger ones.
The ENSEMBLING mode uses a multi-stack ensemble model to predict\n classification and regression tasks directly from your dataset. This machine learning mode\n combines several base models to produce an optimal predictive model. It then uses a\n stacking ensemble method to combine predictions from contributing members. A multi-stack\n ensemble model can provide better performance over a single model by combining the\n predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by\n ENSEMBLING mode.
The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train\n the best version of a model. HPO automatically selects an algorithm for the type of problem\n you want to solve. Then HPO finds the best hyperparameters according to your objective\n metric. See Autopilot algorithm support for a list of algorithms supported by\n HYPERPARAMETER_TUNING mode.
Generates possible candidates without training the models. A model candidate is a\n combination of data preprocessors, algorithms, and algorithm parameter settings.
" + } + }, + "ProblemType": { + "target": "com.amazonaws.sagemaker#ProblemType", + "traits": { + "smithy.api#documentation": "The type of supervised learning problem available for the model candidates of the AutoML\n job V2. For more information, see \n Amazon SageMaker Autopilot problem types.
" + } + }, + "TargetAttributeName": { + "target": "com.amazonaws.sagemaker#TargetAttributeName", + "traits": { + "smithy.api#documentation": "The name of the target variable in supervised learning, usually represented by\n 'y'.
", + "smithy.api#required": {} + } + }, + "SampleWeightAttributeName": { + "target": "com.amazonaws.sagemaker#SampleWeightAttributeName", + "traits": { + "smithy.api#documentation": "If specified, this column name indicates which column of the dataset should be treated\n as sample weights for use by the objective metric during the training, evaluation, and the\n selection of the best model. This column is not considered as a predictive feature. For\n more information on Autopilot metrics, see Metrics and\n validation.
\nSample weights should be numeric, non-negative, with larger values indicating which rows\n are more important than others. Data points that have invalid or no weight value are\n excluded.
\nSupport for sample weights is available in Ensembling\n mode only.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The collection of settings used by an AutoML job V2 for the TABULAR problem\n type.
The type of supervised learning problem available for the model candidates of the AutoML\n job V2 (Binary Classification, Multiclass Classification, Regression). For more\n information, see \n Amazon SageMaker Autopilot problem types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The resolved attributes specific to the TABULAR problem type.
The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column.
" + "smithy.api#documentation": "The name of the column used to provide the sentences to be classified. It should not be\n the same as the target column (Required).
" } }, "TargetLabelColumn": { "target": "com.amazonaws.sagemaker#TargetLabelColumn", "traits": { - "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the\n content column.
" + "smithy.api#documentation": "The name of the column used to provide the class labels. It should not be same as the\n content column (Required).
" } } }, "traits": { - "smithy.api#documentation": "Stores the configuration information for the text classification problem of an AutoML job\n using the V2 API.
" + "smithy.api#documentation": "Stores the configuration information for the text classification problem of an AutoML job\n V2.
" } }, "com.amazonaws.sagemaker#ThingName": { @@ -53569,7 +53742,7 @@ "SecondaryStatus": { "target": "com.amazonaws.sagemaker#SecondaryStatus", "traits": { - "smithy.api#documentation": " Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
Provides detailed information about the state of the training job. For detailed\n information about the secondary status of the training job, see\n StatusMessage under SecondaryStatusTransition.
SageMaker provides primary statuses and secondary statuses that apply to each of\n them:
\n\n Starting\n - Starting the training job.
\n Downloading - An optional stage for algorithms that\n support File training input mode. It indicates that\n data is being downloaded to the ML storage volumes.
\n Training - Training is in progress.
\n Uploading - Training is complete and the model\n artifacts are being uploaded to the S3 location.
\n Completed - The training job has completed.
\n Failed - The training job has failed. The reason for\n the failure is returned in the FailureReason field of\n DescribeTrainingJobResponse.
\n MaxRuntimeExceeded - The job stopped because it\n exceeded the maximum allowed runtime.
\n Stopped - The training job has stopped.
\n Stopping - Stopping the training job.
Valid values for SecondaryStatus are subject to change.
We no longer support the following secondary statuses:
\n\n LaunchingMLInstances\n
\n PreparingTrainingStack\n
\n DownloadingTrainingImage\n
A VpcConfig object that specifies the VPC that this training job has\n access to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" + "smithy.api#documentation": "A VpcConfig object that specifies the VPC that this training job has access\n to. For more information, see Protect Training Jobs by Using an Amazon\n Virtual Private Cloud.
" } }, "StoppingCondition": { @@ -54589,7 +54762,7 @@ "TransformOutput": { "target": "com.amazonaws.sagemaker#TransformOutput", "traits": { - "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results\n from the transform job.
", + "smithy.api#documentation": "Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the\n transform job.
", "smithy.api#required": {} } }, @@ -56131,7 +56304,7 @@ } ], "traits": { - "smithy.api#documentation": "Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).
When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
Deploys the new EndpointConfig specified in the request, switches to\n using newly created endpoint, and then deletes resources provisioned for the endpoint\n using the previous EndpointConfig (there is no availability loss).
When SageMaker receives the request, it sets the endpoint status to\n Updating. After updating the endpoint, it sets the status to\n InService. To check the status of an endpoint, use the DescribeEndpoint API.\n \n
You must not delete an EndpointConfig in use by an endpoint that is\n live or while the UpdateEndpoint or CreateEndpoint\n operations are being performed on the endpoint. To update an endpoint, you must\n create a new EndpointConfig.
If you delete the EndpointConfig of an endpoint that is active or\n being created or updated you may lose visibility into the instance type the endpoint\n is using. The endpoint must be deleted in order to stop incurring charges.
When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to\n true, ExcludeRetainedVariantProperties specifies the list\n of type VariantProperty to override with the values provided by\n EndpointConfig. If you don't specify a value for\n ExcludeRetainedVariantProperties, no variant properties are overridden.\n
When you are updating endpoint resources with RetainAllVariantProperties,\n whose value is set to true, ExcludeRetainedVariantProperties\n specifies the list of type VariantProperty\n to override with the values provided by EndpointConfig. If you don't\n specify a value for ExcludeRetainedVariantProperties, no variant properties\n are overridden.
A list of the Elastic Inference (EI) instance types to associate with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in Amazon SageMaker.
" + "smithy.api#documentation": "A list of the Elastic Inference (EI) instance types to associate with this notebook\n instance. Currently only one EI instance type can be associated with a notebook\n instance. For more information, see Using Elastic Inference in\n Amazon SageMaker.
" } }, "DisassociateAcceleratorTypes": { @@ -58159,13 +58332,13 @@ "VariantPropertyType": { "target": "com.amazonaws.sagemaker#VariantPropertyType", "traits": { - "smithy.api#documentation": "The type of variant property. The supported values are:
\n\n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values\n in the ProductionVariants of CreateEndpointConfig.
\n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.
\n DataCaptureConfig: (Not currently supported.)
The type of variant property. The supported values are:
\n\n DesiredInstanceCount: Overrides the existing variant instance\n counts using the InitialInstanceCount values in the\n ProductionVariants of CreateEndpointConfig.
\n DesiredWeight: Overrides the existing variant weights using the\n InitialVariantWeight values in the\n ProductionVariants of CreateEndpointConfig.
\n DataCaptureConfig: (Not currently supported.)
Specifies a production variant property type for an Endpoint.
\nIf you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to\n true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput\n override the\n existing variant properties of the endpoint.
Specifies a production variant property type for an Endpoint.
\nIf you are updating an endpoint with the RetainAllVariantProperties\n option of UpdateEndpointInput set to true, the\n VariantProperty objects listed in the\n ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the\n endpoint.
Provides details about one of the following actions that affects or that was taken on a resource:
\nA remote IP address issued an Amazon Web Services API call
\nA DNS request was received
\nA remote IP address attempted to connect to an EC2 instance
\nA remote IP address attempted a port probe on an EC2 instance
\n\n Specifies that the rule action should update the Types finding field. The Types \n finding field provides one or more finding types in the format of \n namespace/category/classifier that classify a finding. For more information, see\n Types taxonomy for ASFF in \n the Security Hub User Guide.\n
\n Specifies that the automation rule action is an update to a finding field.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n One or more actions to update finding fields if a finding matches the defined criteria \n of the rule.\n
" + } + }, + "com.amazonaws.securityhub#AutomationRulesActionType": { + "type": "enum", + "members": { + "FINDING_FIELDS_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FINDING_FIELDS_UPDATE" + } + } + } + }, + "com.amazonaws.securityhub#AutomationRulesArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.securityhub#AutomationRulesConfig": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of a rule.\n
" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "\n Whether the rule is active after it is created. If \n this parameter is equal to >ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created.\n
An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.
" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the rule.\n
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n A description of the rule.\n
" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n
\n A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n
" + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "\n One or more actions to update finding fields if a finding matches the defined criteria \n of the rule.\n
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "\n A timestamp that indicates when the rule was created.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n A timestamp that indicates when the rule was most recently updated.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n The principal that created a rule.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Defines the configuration of an automation rule.\n
" + } + }, + "com.amazonaws.securityhub#AutomationRulesConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AutomationRulesConfig" + } + }, + "com.amazonaws.securityhub#AutomationRulesFindingFieldsUpdate": { + "type": "structure", + "members": { + "Note": { + "target": "com.amazonaws.securityhub#NoteUpdate" + }, + "Severity": { + "target": "com.amazonaws.securityhub#SeverityUpdate" + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#VerificationState", + "traits": { + "smithy.api#documentation": "\n The rule action will update the VerificationState field of a finding.\n
\n The rule action will update the Confidence field of a finding.\n
\n The rule action will update the Criticality field of a finding.\n
\n The rule action will update the Types field of a finding.\n
\n The rule action will update the UserDefinedFields field of a finding.\n
\n A list of findings that are related to a finding.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Identifies the finding fields that the automation rule action will update when a \n finding matches the defined criteria.\n
" + } + }, + "com.amazonaws.securityhub#AutomationRulesFindingFilters": { + "type": "structure", + "members": { + "ProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for a third-party product that generated a finding in \n Security Hub.\n
" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID in which a finding was generated.
" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The product-specific identifier for a finding.\n
" + } + }, + "GeneratorId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The identifier for the solution-specific component that \n generated a finding.\n
" + } + }, + "Type": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "One or more finding types in the format of namespace/category/classifier that classify\n a finding. For a list of namespaces, classifiers, and categories, see Types\n taxonomy for ASFF in the Security Hub User Guide.
" + } + }, + "FirstObservedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "\n A timestamp that indicates when the potential security issue captured by a \n finding was first observed by the security findings product.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n A timestamp that indicates when the potential security issue captured by a finding \n was most recently observed by the security findings product.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n A timestamp that indicates when this finding record was created.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n A timestamp that indicates when the finding record was most recently updated. \n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The likelihood that a finding accurately identifies the behavior or issue that it was\n intended to identify. Confidence is scored on a 0–100 basis using a ratio\n scale. A value of 0 means 0 percent confidence, and a value of\n 100 means 100 percent confidence. For example, a data exfiltration\n detection based on a statistical deviation of network traffic has low confidence because an\n actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.
\n The level of importance that is assigned to the resources that are associated with a \n finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports \n only full integers. A score of 0 means that the underlying resources have no \n criticality, and a score of 100 is reserved for the most critical resources. For \n more information, see Criticality in the Security Hub User Guide.
\n A finding's title. \n
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n A finding's description. \n
" + } + }, + "SourceUrl": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n Provides a URL that links to a page about the current finding in the finding product.\n
" + } + }, + "ProductName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n Provides the name of the product that generated the finding. For \n control-based findings, the product name is Security Hub.\n
" + } + }, + "CompanyName": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The name of the company for the product that generated the finding. \n For control-based findings, the company is Amazon Web Services.\n
" + } + }, + "SeverityLabel": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The severity value of the finding.\n
" + } + }, + "ResourceType": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The type of resource that the finding pertains to.\n
" + } + }, + "ResourceId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The identifier for the given resource type. For Amazon Web Services resources that are identified by \n Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, \n this is the identifier as defined by the Amazon Web Service that created the resource. \n For non-Amazon Web Services resources, this is a unique identifier that is associated with the \n resource.\n
" + } + }, + "ResourcePartition": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The partition in which the resource that the finding pertains to is located. \n A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.\n
" + } + }, + "ResourceRegion": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services Region where the resource that a finding pertains to is located.\n
" + } + }, + "ResourceTags": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "\n A list of Amazon Web Services tags associated with a resource at the time the finding was processed.\n
" + } + }, + "ResourceDetailsOther": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "\n Custom fields and values about the resource that a finding pertains to.\n
" + } + }, + "ComplianceStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The result of a security check. This field is only used for findings generated \n from controls.\n
" + } + }, + "ComplianceSecurityControlId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "The security control ID for which a finding was generated. Security control IDs are the same across standards.
" + } + }, + "ComplianceAssociatedStandardsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of \n the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
" + } + }, + "VerificationState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n Provides the veracity of a finding.\n
" + } + }, + "WorkflowStatus": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n Provides information about the status of the investigation into a finding.\n
" + } + }, + "RecordState": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n Provides the current state of a finding.\n
" + } + }, + "RelatedFindingsProductArn": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The ARN for the product that generated a related finding.\n
" + } + }, + "RelatedFindingsId": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The product-generated identifier for a related finding.\n
" + } + }, + "NoteText": { + "target": "com.amazonaws.securityhub#StringFilterList", + "traits": { + "smithy.api#documentation": "\n The text of a user-defined note that's added to a finding.\n
" + } + }, + "NoteUpdatedAt": { + "target": "com.amazonaws.securityhub#DateFilterList", + "traits": { + "smithy.api#documentation": "\n The timestamp of when the note was updated. Uses the date-time format specified in \n RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. \n For example, 2020-03-22T13:22:13.933Z.\n
\n The principal that created a note.\n
" + } + }, + "UserDefinedFields": { + "target": "com.amazonaws.securityhub#MapFilterList", + "traits": { + "smithy.api#documentation": "\n A list of user-defined name and value string pairs added to a finding.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The criteria that determine which findings a rule applies to.\n
" + } + }, + "com.amazonaws.securityhub#AutomationRulesMetadata": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the rule.\n
" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "\n Whether the rule is active after it is created. If \n this parameter is equal to ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n
An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.
" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the rule.\n
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n A description of the rule.\n
" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "\n Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n
\n A timestamp that indicates when the rule was created.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n A timestamp that indicates when the rule was most recently updated.\n
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
\n The principal that created a rule.\n
" } } + }, + "traits": { + "smithy.api#documentation": "\n Metadata for automation rules in the calling account. The response includes rules \n with a RuleStatus of ENABLED and DISABLED.\n
Information about the encryption configuration for X-Ray.
" } }, + "com.amazonaws.securityhub#BatchDeleteAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes one or more automation rules.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/automationrules/delete", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchDeleteAutomationRulesRequest": { + "type": "structure", + "members": { + "AutomationRulesArns": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "\n A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchDeleteAutomationRulesResponse": { + "type": "structure", + "members": { + "ProcessedAutomationRules": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "\n A list of properly processed rule ARNs.\n
" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't delete and why.\n
\n Retrieves a list of details for automation rules based on rule Amazon Resource Names \n (ARNs).\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/automationrules/get", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchGetAutomationRulesRequest": { + "type": "structure", + "members": { + "AutomationRulesArns": { + "target": "com.amazonaws.securityhub#AutomationRulesArnsList", + "traits": { + "smithy.api#documentation": "\n A list of rule ARNs to get details for.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#BatchGetAutomationRulesResponse": { + "type": "structure", + "members": { + "Rules": { + "target": "com.amazonaws.securityhub#AutomationRulesConfigList", + "traits": { + "smithy.api#documentation": "\n A list of rule details for the provided rule ARNs.\n
" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't retrieve and why.\n
\n Updates one or more automation rules based on rule Amazon Resource Names (ARNs) \n and input parameters.\n
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/automationrules/update", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#BatchUpdateAutomationRulesRequest": { + "type": "structure", + "members": { + "UpdateAutomationRulesRequestItems": { + "target": "com.amazonaws.securityhub#UpdateAutomationRulesRequestItemsList", + "traits": { + "smithy.api#documentation": "\n An array of ARNs for the rules that are to be updated. Optionally, you can also include \n RuleStatus and RuleOrder.\n
\n A list of properly processed rule ARNs.\n
" + } + }, + "UnprocessedAutomationRules": { + "target": "com.amazonaws.securityhub#UnprocessedAutomationRulesList", + "traits": { + "smithy.api#documentation": "\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't update and why.\n
The 2-letter ISO 3166 country code for the country.
" + } + }, + "CountryName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the country.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a country.
" + } + }, + "com.amazonaws.securityhub#CreateActionTarget": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateActionTargetRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateActionTargetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceConflictException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a custom action target in Security Hub.
\nYou can use custom actions on findings and insights in Security Hub to trigger target actions\n in Amazon CloudWatch Events.
", + "smithy.api#http": { + "method": "POST", + "uri": "/actionTargets", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateActionTargetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the custom action target. Can contain up to 20 characters.
", + "smithy.api#required": {} } }, - "DISABLED": { - "target": "smithy.api#Unit", + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#documentation": "The description for the custom action target.
", + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ID for the custom action target. Can contain up to 20 alphanumeric characters.
", + "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, - "com.amazonaws.securityhub#Country": { + "com.amazonaws.securityhub#CreateActionTargetResponse": { "type": "structure", "members": { - "CountryCode": { - "target": "com.amazonaws.securityhub#NonEmptyString", - "traits": { - "smithy.api#documentation": "The 2-letter ISO 3166 country code for the country.
" - } - }, - "CountryName": { + "ActionTargetArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The name of the country.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the custom action target.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Information about a country.
" + "smithy.api#output": {} } }, - "com.amazonaws.securityhub#CreateActionTarget": { + "com.amazonaws.securityhub#CreateAutomationRule": { "type": "operation", "input": { - "target": "com.amazonaws.securityhub#CreateActionTargetRequest" + "target": "com.amazonaws.securityhub#CreateAutomationRuleRequest" }, "output": { - "target": "com.amazonaws.securityhub#CreateActionTargetResponse" + "target": "com.amazonaws.securityhub#CreateAutomationRuleResponse" }, "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, { "target": "com.amazonaws.securityhub#InternalException" }, @@ -20050,41 +20821,72 @@ }, { "target": "com.amazonaws.securityhub#LimitExceededException" - }, - { - "target": "com.amazonaws.securityhub#ResourceConflictException" } ], "traits": { - "smithy.api#documentation": "Creates a custom action target in Security Hub.
\nYou can use custom actions on findings and insights in Security Hub to trigger target actions\n in Amazon CloudWatch Events.
", + "smithy.api#documentation": "\n Creates an automation rule based on input parameters.\n
", "smithy.api#http": { "method": "POST", - "uri": "/actionTargets", + "uri": "/automationrules/create", "code": 200 } } }, - "com.amazonaws.securityhub#CreateActionTargetRequest": { + "com.amazonaws.securityhub#CreateAutomationRuleRequest": { "type": "structure", "members": { - "Name": { + "Tags": { + "target": "com.amazonaws.securityhub#TagMap", + "traits": { + "smithy.api#documentation": "\n User-defined tags that help you label the purpose of a rule. \n
" + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "\n Whether the rule is active after it is created. If \n this parameter is equal to Enabled, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n
An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.
", + "smithy.api#required": {} + } + }, + "RuleName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The name of the custom action target. Can contain up to 20 characters.
", + "smithy.api#documentation": "\n The name of the rule.\n
", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The description for the custom action target.
", + "smithy.api#documentation": "\n A description of the rule.\n
", "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The ID for the custom action target. Can contain up to 20 alphanumeric characters.
", + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding \n matches the criteria for multiple rules, and each rule has different actions. If the value of this field is \n set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding. The default value of this field is false.\n
\n A set of ASFF finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n
", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "\n One or more actions to update finding fields if a finding matches the conditions \n specified in Criteria. \n
The Amazon Resource Name (ARN) for the custom action target.
", - "smithy.api#required": {} + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the automation rule that you created.\n
" } } }, @@ -23507,6 +24308,83 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.securityhub#ListAutomationRules": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#ListAutomationRulesRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#ListAutomationRulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "\n A list of automation rules and their metadata for the calling account.\n
", + "smithy.api#http": { + "method": "GET", + "uri": "/automationrules/list", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#ListAutomationRulesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "\n A token to specify where to start paginating the response. This is the NextToken \n from a previously truncated response. On your first call to the ListAutomationRules \n API, set the value of this parameter to NULL.\n
The maximum number of rules to return in the response. This currently ranges from 1 to\n 100.
", + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#ListAutomationRulesResponse": { + "type": "structure", + "members": { + "AutomationRulesMetadata": { + "target": "com.amazonaws.securityhub#AutomationRulesMetadataList", + "traits": { + "smithy.api#documentation": "\n Metadata for rules in the calling account. The response includes rules with a \n RuleStatus of ENABLED and DISABLED.\n
\n A pagination token for the response.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.securityhub#ListEnabledProductsForImport": { "type": "operation", "input": { @@ -26640,6 +27518,33 @@ "smithy.api#documentation": "A list of port ranges.
" } }, + "com.amazonaws.securityhub#RuleOrderValue": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.securityhub#RuleStatus": { + "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.securityhub#SecurityControl": { "type": "structure", "members": { @@ -26775,12 +27680,18 @@ { "target": "com.amazonaws.securityhub#AcceptInvitation" }, + { + "target": "com.amazonaws.securityhub#BatchDeleteAutomationRules" + }, { "target": "com.amazonaws.securityhub#BatchDisableStandards" }, { "target": "com.amazonaws.securityhub#BatchEnableStandards" }, + { + "target": "com.amazonaws.securityhub#BatchGetAutomationRules" + }, { "target": "com.amazonaws.securityhub#BatchGetSecurityControls" }, @@ -26790,6 +27701,9 @@ { "target": "com.amazonaws.securityhub#BatchImportFindings" }, + { + "target": "com.amazonaws.securityhub#BatchUpdateAutomationRules" + }, { "target": "com.amazonaws.securityhub#BatchUpdateFindings" }, @@ -26799,6 +27713,9 @@ { "target": "com.amazonaws.securityhub#CreateActionTarget" }, + { + "target": "com.amazonaws.securityhub#CreateAutomationRule" + }, { "target": "com.amazonaws.securityhub#CreateFindingAggregator" }, @@ -26904,6 +27821,9 @@ { "target": "com.amazonaws.securityhub#InviteMembers" }, + { + "target": "com.amazonaws.securityhub#ListAutomationRules" + }, { "target": "com.amazonaws.securityhub#ListEnabledProductsForImport" }, @@ -29294,6 +30214,39 @@ "target": "com.amazonaws.securityhub#NonEmptyString" } }, + "com.amazonaws.securityhub#UnprocessedAutomationRule": { + "type": "structure", + "members": { + "RuleArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the unprocessed automation rule.\n
" + } + }, + "ErrorCode": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The error code associated with the unprocessed automation rule.\n
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n An error message describing why a request didn't process a specific rule.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter \n tells you which automation rules the request didn't process and why.\n
\n The Amazon Resource Name (ARN) for the rule.\n
", + "smithy.api#required": {} + } + }, + "RuleStatus": { + "target": "com.amazonaws.securityhub#RuleStatus", + "traits": { + "smithy.api#documentation": "\n Whether the rule is active after it is created. If \n this parameter is equal to ENABLED, Security Hub will apply the rule to findings \n and finding updates after the rule is created. To change the value of this\n parameter after creating a rule, use BatchUpdateAutomationRules.\n
An integer ranging from 1 to 1000 that represents the order in which the rule action is\n applied to findings. Security Hub applies rules with lower values for this parameter\n first.
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n A description of the rule.\n
" + } + }, + "RuleName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The name of the rule.\n
" + } + }, + "IsTerminal": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful \n when a finding matches the criteria for multiple rules, and each rule has different actions. If the value of this \n field is set to true for a rule, Security Hub applies the rule action to a finding that matches \n the rule criteria and won't evaluate other rules for the finding.\u2028 The default value of this field is false.\n
\n A set of ASFF finding field attributes and corresponding expected values that \n Security Hub uses to filter findings. If a finding matches the conditions specified in\n this parameter, Security Hub applies the rule action to the finding.\n
" + } + }, + "Actions": { + "target": "com.amazonaws.securityhub#ActionList", + "traits": { + "smithy.api#documentation": "\n One or more actions to update finding fields if a finding matches the conditions \n specified in Criteria.\n
\n Specifies the parameters to update in an existing automation rule.\n
" + } + }, + "com.amazonaws.securityhub#UpdateAutomationRulesRequestItemsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#UpdateAutomationRulesRequestItem" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.securityhub#UpdateFindingAggregator": { "type": "operation", "input": { diff --git a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json index 53e658538bb..679cd0b6017 100644 --- a/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json +++ b/codegen/sdk-codegen/aws-models/service-catalog.2015-12-10.json @@ -1603,14 +1603,14 @@ "PrincipalARN": { "target": "com.amazonaws.servicecatalog#PrincipalARN", "traits": { - "smithy.api#documentation": "The ARN of the principal (user, role, or group). The supported value is a fully defined \n IAM ARN \n if the \n PrincipalType is IAM. If the PrincipalType is IAM_PATTERN, \n the supported value is an IAM ARN without an AccountID in the following format:
\n arn:partition:iam:::resource-type/resource-id\n
\nThe resource-id can be either of the following:
\nFully formed, for example arn:aws:iam:::role/resource-name or \n arn:aws:iam:::role/resource-path/resource-name\n
\nA wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a \n \"*\" or \"?\" in the resource-id segment of the ARN, for example arn:partition:service:::resource-type/resource-path/resource-name. \n The new symbols are exclusive to the resource-path and resource-name \n and cannot be used to replace the resource-type or other \n ARN values.
Examples of an acceptable wildcard ARN:
\narn:aws:iam:::role/ResourceName_*
\narn:aws:iam:::role/*/ResourceName_?
\nExamples of an unacceptable wildcard ARN:
\narn:aws:iam:::*/ResourceName
\nYou can associate multiple IAM_PATTERNs even if the account has no principal \n with that name.
The ARN path and principal name allow unlimited wildcard characters.
\nThe \"?\" wildcard character matches zero or one of any character. This is similar to \".?\" in regular \n regex context.
\nThe \"*\" wildcard character matches any number of any characters. This is similar \".*\" in regular \n regex context.
\nIn the IAM Principal ARNs format (arn:partition:iam:::resource-type/resource-path/resource-name), \n valid resource-type values include user/, group/, or role/. The \"?\" and \"*\" \n are allowed only after the resource-type, in the resource-id segment. \n You can use special characters anywhere within the resource-id.
\nThe \"*\" also matches the \"/\" character, allowing paths to be formed within the \n resource-id. \n For example, arn:aws:iam:::role/*/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 \n and \n arn:aws:iam:::role/pathA/ResourceName_1.
\nThe ARN of the principal (user, role, or group). If the PrincipalType is IAM, the supported value is a \n fully defined \n IAM Amazon Resource Name (ARN). \n If the PrincipalType is IAM_PATTERN, \n the supported value is an IAM ARN without an AccountID in the following format:
\n arn:partition:iam:::resource-type/resource-id\n
\nThe ARN resource-id can be either:
\nA fully formed resource-id. For example, arn:aws:iam:::role/resource-name or \n arn:aws:iam:::role/resource-path/resource-name\n
\nA wildcard ARN. The wildcard ARN accepts IAM_PATTERN values with a \n \"*\" or \"?\" in the resource-id segment of the ARN. For example arn:partition:service:::resource-type/resource-path/resource-name. \n The new symbols are exclusive to the resource-path and resource-name \n and cannot replace the resource-type or other \n ARN values.
The ARN path and principal name allow unlimited wildcard characters.
\nExamples of an acceptable wildcard ARN:
\narn:aws:iam:::role/ResourceName_*
\narn:aws:iam:::role/*/ResourceName_?
\nExamples of an unacceptable wildcard ARN:
\narn:aws:iam:::*/ResourceName
\nYou can associate multiple IAM_PATTERNs even if the account has no principal \n with that name.
The \"?\" wildcard character matches zero or one of any character. This is similar to \".?\" in regular \n regex context. The \"*\" wildcard character matches any number of any characters. \n This is similar to \".*\" in regular regex context.
\nIn the IAM Principal ARN format (arn:partition:iam:::resource-type/resource-path/resource-name), \n valid resource-type values include user/, group/, \n or role/. The \"?\" and \"*\" characters\n are allowed only after the resource-type in the resource-id segment. \n You can use special characters anywhere within the resource-id.
\nThe \"*\" character also matches the \"/\" character, allowing paths to be formed within the \n resource-id. For example, arn:aws:iam:::role/*/ResourceName_? \n matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1 \n and \n arn:aws:iam:::role/pathA/ResourceName_1.
", "smithy.api#required": {} } }, "PrincipalType": { "target": "com.amazonaws.servicecatalog#PrincipalType", "traits": { - "smithy.api#documentation": "The principal type. The supported value is IAM if you use a fully defined ARN, \n or IAM_PATTERN if you use an ARN with no accountID, with or without wildcard characters.
The principal type. The supported value is IAM if you use a fully defined Amazon Resource Name \n (ARN), or IAM_PATTERN if you use an ARN with no accountID, \n with or without wildcard characters.
Indicates whether a verbose level of detail is enabled.
" } + }, + "IncludeProvisioningArtifactParameters": { + "target": "com.amazonaws.servicecatalog#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates if the API call response does or does not include additional details about the provisioning parameters.
" + } } }, "traits": { @@ -4367,6 +4374,12 @@ "traits": { "smithy.api#documentation": "The status of the current request.
" } + }, + "ProvisioningArtifactParameters": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactParameters", + "traits": { + "smithy.api#documentation": "Information about the parameters used to provision the product.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/signer.2017-08-25.json b/codegen/sdk-codegen/aws-models/signer.2017-08-25.json index fa7579a391c..d818fd25b56 100644 --- a/codegen/sdk-codegen/aws-models/signer.2017-08-25.json +++ b/codegen/sdk-codegen/aws-models/signer.2017-08-25.json @@ -139,6 +139,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#AddProfilePermissionResponse": { @@ -150,6 +153,9 @@ "smithy.api#documentation": "A unique identifier for the current profile revision.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#Arn": { @@ -177,6 +183,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.signer#Blob": { + "type": "blob" + }, "com.amazonaws.signer#BucketName": { "type": "string" }, @@ -222,22 +231,31 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#Category": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "AWSIoT", - "name": "AWSIoT" + "type": "enum", + "members": { + "AWSIoT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWSIoT" } - ] + } } }, "com.amazonaws.signer#CertificateArn": { "type": "string" }, + "com.amazonaws.signer#CertificateHashes": { + "type": "list", + "member": { + "target": "com.amazonaws.signer#String" + } + }, "com.amazonaws.signer#ClientRequestToken": { "type": "string" }, @@ -280,7 +298,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about a specific code signing job. You specify the job by using\n\t\t\tthe jobId value that is returned by the StartSigningJob\n\t\t\toperation.
Returns information about a specific code signing job. You specify the job by using the\n\t\t\t\tjobId value that is returned by the StartSigningJob\n\t\t\toperation.
The IAM entity that initiated the signing job.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#Destination": { @@ -471,18 +495,20 @@ "type": "string" }, "com.amazonaws.signer#EncryptionAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "RSA", - "name": "RSA" - }, - { - "value": "ECDSA", - "name": "ECDSA" + "type": "enum", + "members": { + "RSA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA" } - ] + }, + "ECDSA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECDSA" + } + } } }, "com.amazonaws.signer#EncryptionAlgorithmOptions": { @@ -519,6 +545,102 @@ "com.amazonaws.signer#ErrorMessage": { "type": "string" }, + "com.amazonaws.signer#GetRevocationStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.signer#GetRevocationStatusRequest" + }, + "output": { + "target": "com.amazonaws.signer#GetRevocationStatusResponse" + }, + "errors": [ + { + "target": "com.amazonaws.signer#AccessDeniedException" + }, + { + "target": "com.amazonaws.signer#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.signer#TooManyRequestsException" + }, + { + "target": "com.amazonaws.signer#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves the\n\t\t\trevocation status of one or more of the signing profile, signing job, and signing\n\t\t\tcertificate.
", + "smithy.api#endpoint": { + "hostPrefix": "verification." + }, + "smithy.api#http": { + "method": "GET", + "uri": "/revocations", + "code": 200 + } + } + }, + "com.amazonaws.signer#GetRevocationStatusRequest": { + "type": "structure", + "members": { + "signatureTimestamp": { + "target": "com.amazonaws.signer#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the signature that validates the profile or job.
", + "smithy.api#httpQuery": "signatureTimestamp", + "smithy.api#required": {} + } + }, + "platformId": { + "target": "com.amazonaws.signer#PlatformId", + "traits": { + "smithy.api#documentation": "The ID of a signing platform.
", + "smithy.api#httpQuery": "platformId", + "smithy.api#required": {} + } + }, + "profileVersionArn": { + "target": "com.amazonaws.signer#Arn", + "traits": { + "smithy.api#documentation": "The version of a signing profile.
", + "smithy.api#httpQuery": "profileVersionArn", + "smithy.api#required": {} + } + }, + "jobArn": { + "target": "com.amazonaws.signer#Arn", + "traits": { + "smithy.api#documentation": "The ARN of a signing job.
", + "smithy.api#httpQuery": "jobArn", + "smithy.api#required": {} + } + }, + "certificateHashes": { + "target": "com.amazonaws.signer#CertificateHashes", + "traits": { + "smithy.api#documentation": "A list of composite signed hashes that identify certificates.
\n\t\tA certificate identifier consists of a subject certificate TBS hash (signed by the\n\t\t\tparent CA) combined with a parent CA TBS hash (signed by the parent CA’s CA). Root\n\t\t\tcertificates are defined as their own CA.
", + "smithy.api#httpQuery": "certificateHashes", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.signer#GetRevocationStatusResponse": { + "type": "structure", + "members": { + "revokedEntities": { + "target": "com.amazonaws.signer#RevokedEntities", + "traits": { + "smithy.api#documentation": "A list of revoked entities (including one or more of the signing profile ARN, signing\n\t\t\tjob ID, and certificate hash) supplied as input to the API.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.signer#GetSigningPlatform": { "type": "operation", "input": { @@ -561,6 +683,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#GetSigningPlatformResponse": { @@ -622,6 +747,9 @@ "smithy.api#documentation": "A flag indicating whether signatures generated for the signing platform can be\n\t\t\trevoked.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#GetSigningProfile": { @@ -673,6 +801,9 @@ "smithy.api#httpQuery": "profileOwner" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#GetSigningProfileResponse": { @@ -756,21 +887,26 @@ "smithy.api#documentation": "A list of tags associated with the signing profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#HashAlgorithm": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "SHA1", - "name": "SHA1" - }, - { - "value": "SHA256", - "name": "SHA256" + "type": "enum", + "members": { + "SHA1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA1" + } + }, + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA256" } - ] + } } }, "com.amazonaws.signer#HashAlgorithmOptions": { @@ -802,22 +938,26 @@ } }, "com.amazonaws.signer#ImageFormat": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "JSON", - "name": "JSON" - }, - { - "value": "JSONEmbedded", - "name": "JSONEmbedded" - }, - { - "value": "JSONDetached", - "name": "JSONDetached" + "type": "enum", + "members": { + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + }, + "JSONEmbedded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONEmbedded" } - ] + }, + "JSONDetached": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSONDetached" + } + } } }, "com.amazonaws.signer#ImageFormats": { @@ -906,6 +1046,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#ListProfilePermissionsResponse": { @@ -936,6 +1079,9 @@ "smithy.api#documentation": "String for specifying the next set of paginated results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningJobs": { @@ -1041,6 +1187,9 @@ "smithy.api#httpQuery": "jobInvoker" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#ListSigningJobsResponse": { @@ -1058,6 +1207,9 @@ "smithy.api#documentation": "String for specifying the next set of paginated results.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningPlatforms": { @@ -1134,6 +1286,9 @@ "smithy.api#httpQuery": "nextToken" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#ListSigningPlatformsResponse": { @@ -1151,6 +1306,9 @@ "smithy.api#documentation": "Value for specifying the next set of paginated results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#ListSigningProfiles": { @@ -1225,6 +1383,9 @@ "smithy.api#httpQuery": "statuses" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#ListSigningProfilesResponse": { @@ -1242,6 +1403,9 @@ "smithy.api#documentation": "Value for specifying the next set of paginated results to return.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#ListTagsForResource": { @@ -1286,6 +1450,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#ListTagsForResourceResponse": { @@ -1297,6 +1464,9 @@ "smithy.api#documentation": "A list of tags associated with the signing profile.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#MaxResults": { @@ -1314,6 +1484,15 @@ "smithy.api#default": 0 } }, + "com.amazonaws.signer#Metadata": { + "type": "map", + "key": { + "target": "com.amazonaws.signer#String" + }, + "value": { + "target": "com.amazonaws.signer#String" + } + }, "com.amazonaws.signer#NextToken": { "type": "string" }, @@ -1333,6 +1512,15 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.signer#Payload": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, "com.amazonaws.signer#Permission": { "type": "structure", "members": { @@ -1390,7 +1578,7 @@ "min": 2, "max": 64 }, - "smithy.api#pattern": "^[a-zA-Z0-9_]{2,}" + "smithy.api#pattern": "^[a-zA-Z0-9_]{2,}$" } }, "com.amazonaws.signer#ProfileVersion": { @@ -1429,7 +1617,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a signing profile. A signing profile is a code signing template that can be used to\n\t\t\tcarry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html\n
", + "smithy.api#documentation": "Creates a signing profile. A signing profile is a code signing template that can be used to\n\t\t\tcarry out a pre-defined signing job.\n\t\t\t
", "smithy.api#http": { "method": "PUT", "uri": "/signing-profiles/{profileName}", @@ -1485,6 +1673,9 @@ "smithy.api#documentation": "Tags to be associated with the signing profile that is being created.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#PutSigningProfileResponse": { @@ -1508,6 +1699,9 @@ "smithy.api#documentation": "The signing profile ARN, including the profile version.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#RemoveProfilePermission": { @@ -1574,6 +1768,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#RemoveProfilePermissionResponse": { @@ -1585,6 +1782,9 @@ "smithy.api#documentation": "An identifier for the current revision of the profile permissions.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#RequestedBy": { @@ -1673,6 +1873,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#RevokeSigningProfile": { @@ -1741,6 +1944,15 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.signer#RevokedEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.signer#String" } }, "com.amazonaws.signer#S3Destination": { @@ -1828,6 +2040,107 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.signer#SignPayload": { + "type": "operation", + "input": { + "target": "com.amazonaws.signer#SignPayloadRequest" + }, + "output": { + "target": "com.amazonaws.signer#SignPayloadResponse" + }, + "errors": [ + { + "target": "com.amazonaws.signer#AccessDeniedException" + }, + { + "target": "com.amazonaws.signer#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.signer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.signer#TooManyRequestsException" + }, + { + "target": "com.amazonaws.signer#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Signs a binary\n\t\t\tpayload and returns a signature envelope.
", + "smithy.api#http": { + "method": "POST", + "uri": "/signing-jobs/with-payload", + "code": 200 + } + } + }, + "com.amazonaws.signer#SignPayloadRequest": { + "type": "structure", + "members": { + "profileName": { + "target": "com.amazonaws.signer#ProfileName", + "traits": { + "smithy.api#documentation": "The name of the signing profile.
", + "smithy.api#required": {} + } + }, + "profileOwner": { + "target": "com.amazonaws.signer#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID of the profile owner.
" + } + }, + "payload": { + "target": "com.amazonaws.signer#Payload", + "traits": { + "smithy.api#documentation": "Specifies the object digest (hash) to sign.
", + "smithy.api#required": {} + } + }, + "payloadFormat": { + "target": "com.amazonaws.signer#String", + "traits": { + "smithy.api#documentation": "Payload content type
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.signer#SignPayloadResponse": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.signer#JobId", + "traits": { + "smithy.api#documentation": "Unique identifier of the signing job.
" + } + }, + "jobOwner": { + "target": "com.amazonaws.signer#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID of the job owner.
" + } + }, + "metadata": { + "target": "com.amazonaws.signer#Metadata", + "traits": { + "smithy.api#documentation": "Information including the signing profile ARN and the signing job ID. Clients use\n\t\t\tmetadata to signature records, for example, as annotations added to the signature\n\t\t\tmanifest inside an OCI registry.
" + } + }, + "signature": { + "target": "com.amazonaws.signer#Blob", + "traits": { + "smithy.api#documentation": "A cryptographic signature.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.signer#SignatureValidityPeriod": { "type": "structure", "members": { @@ -1841,7 +2154,7 @@ "type": { "target": "com.amazonaws.signer#ValidityType", "traits": { - "smithy.api#documentation": "The time unit for signature\n\t\t\tvalidity.
" + "smithy.api#documentation": "The time unit for signature validity.
" } } }, @@ -2088,7 +2401,7 @@ "platformId": { "target": "com.amazonaws.signer#String", "traits": { - "smithy.api#documentation": "The ID of a code signing; platform.
" + "smithy.api#documentation": "The ID of a code signing platform.
" } }, "displayName": { @@ -2270,22 +2583,26 @@ } }, "com.amazonaws.signer#SigningProfileStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "Active", - "name": "Active" - }, - { - "value": "Canceled", - "name": "Canceled" - }, - { - "value": "Revoked", - "name": "Revoked" + "type": "enum", + "members": { + "Active": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Active" } - ] + }, + "Canceled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Canceled" + } + }, + "Revoked": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Revoked" + } + } } }, "com.amazonaws.signer#SigningProfiles": { @@ -2295,22 +2612,26 @@ } }, "com.amazonaws.signer#SigningStatus": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "InProgress", - "name": "InProgress" - }, - { - "value": "Failed", - "name": "Failed" - }, - { - "value": "Succeeded", - "name": "Succeeded" + "type": "enum", + "members": { + "InProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InProgress" + } + }, + "Failed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Failed" } - ] + }, + "Succeeded": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Succeeded" + } + } } }, "com.amazonaws.signer#Source": { @@ -2356,7 +2677,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:
You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the\n\t\t\t\t\t\tAmazon S3 Getting Started Guide.
\n\t\t\tYour S3 source bucket must be version enabled.
\n\t\t\tYou must create an S3 destination bucket. Code signing uses your S3 destination\n\t\t\t\t\tbucket to write your signed code.
\n\t\t\tYou specify the name of the source and destination buckets when calling the\n\t\t\t\t\t\tStartSigningJob operation.
You must also specify a request token that identifies your request to\n\t\t\t\t\tcode signing.
\n\t\t\tYou can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.
For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/\n
", + "smithy.api#documentation": "Initiates a signing job to be performed on the code provided. Signing jobs are\n\t\t\tviewable by the ListSigningJobs operation for two years after they are\n\t\t\tperformed. Note the following requirements:
You must create an Amazon S3 source bucket. For more information, see Creating a Bucket in the\n\t\t\t\t\t\tAmazon S3 Getting Started Guide.
\n\t\t\tYour S3 source bucket must be version enabled.
\n\t\t\tYou must create an S3 destination bucket. Code signing uses your S3 destination\n\t\t\t\t\tbucket to write your signed code.
\n\t\t\tYou specify the name of the source and destination buckets when calling the\n\t\t\t\t\t\tStartSigningJob operation.
You must also specify a request token that identifies your request to\n\t\t\t\t\tcode signing.
\n\t\t\tYou can call the DescribeSigningJob and the ListSigningJobs actions after you call\n\t\t\tStartSigningJob.
For a Java example that shows how to use this action, see StartSigningJob.
", "smithy.api#http": { "method": "POST", "uri": "/signing-jobs", @@ -2402,6 +2723,9 @@ "smithy.api#documentation": "The AWS account ID of the signing profile owner.
" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#StartSigningJobResponse": { @@ -2419,6 +2743,9 @@ "smithy.api#documentation": "The AWS account ID of the signing job owner.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.signer#StatusReason": { @@ -2519,11 +2846,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.signer#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.signer#TagValue": { "type": "string", @@ -2548,7 +2881,7 @@ "smithy.api#deprecated": { "message": "Instead of this error, TooManyRequestsException should be used." }, - "smithy.api#documentation": "The request was denied due to request throttling.
\nInstead of this error, TooManyRequestsException should be used.
The request was denied due to request throttling.
\n\t\tInstead of this error, TooManyRequestsException should be used.
The allowed number of job-signing requests has been exceeded.
\n\t\tThis error supersedes the error ThrottlingException.
The allowed number of job-signing requests has been exceeded.
\n\t\tThis error supersedes the error ThrottlingException.
AWS Signer is a fully managed code signing service to help you ensure the trust and\n\t\t\tintegrity of your code.
\n\t\tAWS Signer supports the following applications:
\n\n\t\tWith code signing for AWS Lambda, you can sign AWS Lambda\n\t\t\tdeployment packages. Integrated support is provided for Amazon S3, Amazon CloudWatch,\n\t\t\tand AWS CloudTrail. In order to sign code, you create a signing profile and then use\n\t\t\tSigner to sign Lambda zip files in S3.
\n\t\t\n\t\tWith code signing for IoT, you can sign code for any IoT device that is\n\t\t\tsupported by AWS. IoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is\n\t\t\tintegrated with AWS Certificate Manager (ACM). In order to sign\n\t\t\tcode, you import a third-party code signing certificate using ACM, and use that to\n\t\t\tsign updates in Amazon FreeRTOS and AWS IoT Device Management.
\n\t\tFor more information about AWS Signer, see the AWS Signer Developer Guide.
\n\t\t\n\t\t ", + "smithy.api#documentation": "AWS Signer is a fully managed code signing service to help you ensure the trust and\n\t\t\tintegrity of your code.
\n\t\tAWS Signer supports the following applications:
\n\t\tWith code signing for AWS Lambda, you can sign AWS\n\t\t\t\tLambda deployment packages. Integrated support is provided for Amazon S3, Amazon\n\t\t\t\tCloudWatch, and AWS CloudTrail. In order\n\t\t\tto sign code, you create a signing profile and then use Signer to sign Lambda zip files\n\t\t\tin S3.
\n\t\tWith code signing for IoT, you can sign code for any IoT device that is supported by AWS.\n\t\t\tIoT code signing is available for Amazon FreeRTOS and AWS IoT Device Management, and is integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing\n\t\t\tcertificate using ACM, and use that to sign updates in Amazon FreeRTOS and AWS IoT Device Management.
\n\t\tWith code signing for\n\t\t\tcontainers …(TBD)
\n\t\tFor more information about AWS Signer, see the AWS Signer Developer\n\t\t\tGuide.
", "smithy.api#title": "AWS Signer", "smithy.rules#endpointRuleSet": { "version": "1.0", diff --git a/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json b/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json index 6b8e254a1ce..3f8be46b535 100644 --- a/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json +++ b/codegen/sdk-codegen/aws-models/simspaceweaver.2022-10-28.json @@ -162,7 +162,7 @@ "Destination": { "target": "com.amazonaws.simspaceweaver#S3Destination", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.
", + "smithy.api#documentation": "The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.
\nThe Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.
", "smithy.api#required": {} } } @@ -911,7 +911,7 @@ "min": 0, "max": 1600 }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):log-group:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:role\\/(.+)$" } }, "com.amazonaws.simspaceweaver#LoggingConfiguration": { @@ -995,7 +995,7 @@ "min": 0, "max": 1600 }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):iam::(\\d{12})?:role\\/(.+)$" + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):iam::(\\d{12})?:role\\/(.+)$" } }, "com.amazonaws.simspaceweaver#S3Destination": { @@ -1472,9 +1472,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-gov-east-1" } }, { @@ -1485,9 +1485,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-gov-east-1" } }, { @@ -1498,9 +1498,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-gov-east-1" } }, { @@ -1511,9 +1511,9 @@ } }, "params": { - "Region": "us-gov-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-gov-east-1" } }, { @@ -1524,9 +1524,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "cn-north-1" } }, { @@ -1537,9 +1537,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "cn-north-1" } }, { @@ -1550,9 +1550,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "cn-north-1" } }, { @@ -1563,9 +1563,9 @@ } }, "params": { - "Region": "cn-north-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "cn-north-1" } }, { @@ -1574,9 +1574,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-iso-east-1" } }, { @@ -1587,9 +1587,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-iso-east-1" } }, { @@ -1598,9 +1598,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-iso-east-1" } }, { @@ -1611,9 +1611,9 @@ } }, "params": { - "Region": "us-iso-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-iso-east-1" } }, { @@ -1624,9 +1624,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -1637,9 +1637,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -1650,9 +1650,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-east-1" } }, { @@ -1663,9 +1663,9 @@ } }, "params": { - "Region": "us-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-east-1" } }, { @@ -1674,9 +1674,9 @@ "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": true, - "UseDualStack": true + "Region": "us-isob-east-1" } }, { @@ -1687,9 +1687,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": true, - "UseDualStack": false + "Region": "us-isob-east-1" } }, { @@ -1698,9 +1698,9 @@ "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": true, "UseFIPS": false, - "UseDualStack": true + "Region": "us-isob-east-1" } }, { @@ -1711,9 +1711,9 @@ } }, "params": { - "Region": "us-isob-east-1", + "UseDualStack": false, "UseFIPS": false, - "UseDualStack": false + "Region": "us-isob-east-1" } }, { @@ -1724,9 +1724,9 @@ } }, "params": { - "Region": "us-east-1", - "UseFIPS": false, "UseDualStack": false, + "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1736,9 +1736,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseFIPS": true, "UseDualStack": false, + "UseFIPS": true, + "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -1748,9 +1748,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "Region": "us-east-1", - "UseFIPS": false, "UseDualStack": true, + "UseFIPS": false, + "Region": "us-east-1", "Endpoint": "https://example.com" } } @@ -1766,7 +1766,7 @@ "min": 0, "max": 1600 }, - "smithy.api#pattern": "^arn:(?:aws|aws-cn):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" + "smithy.api#pattern": "^arn:(?:aws|aws-cn|aws-us-gov):simspaceweaver:([a-z]{2}-[a-z]+-\\d{1}):(\\d{12})?:([a-z]+)\\/(.+)$" } }, "com.amazonaws.simspaceweaver#SimSpaceWeaverLongResourceName": { @@ -2361,7 +2361,7 @@ "SnapshotS3Location": { "target": "com.amazonaws.simspaceweaver#S3Location", "traits": { - "smithy.api#documentation": "The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .
\nProvide a SnapshotS3Location to start your simulation from a snapshot.
If you provide a SnapshotS3Location then you can't provide a SchemaS3Location.
The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).\n For more information about Amazon S3, see the \n Amazon Simple Storage Service User Guide\n .
\nProvide a SnapshotS3Location to start your simulation from a snapshot.
The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.
\nIf you provide a SnapshotS3Location then you can't provide a SchemaS3Location.
Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.
\nWhen you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
\n\n AddPermission generates a policy for you. You can use \n \n SetQueueAttributes\n to\n upload your policy. For more information, see\n Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nAdds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
\n\n AddPermission generates a policy for you. You can use\n \n SetQueueAttributes\n to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account\n principal.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
The unique identification of the permission you're setting (for example,\n AliceSendMessage). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-), and underscores\n (_).
The action the client wants to allow for the specified principal. Valid values: the name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.
The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or\n ChangeMessageVisibility for ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch, DeleteMessageBatch, and\n ChangeMessageVisibilityBatch.
Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n
\nYou can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nWelcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nCancels a specified message movement task.
\nA message movement can only be cancelled when the current status is\n RUNNING.
\nCancelling a message movement task does not revert the messages that have\n already been moved. It can only stop the messages that have not been moved\n yet.
\nAn identifier associated with a message movement task.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#CancelMessageMoveTaskResult": { + "type": "structure", + "members": { + "ApproximateNumberOfMessagesMoved": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The approximate number of messages already moved to the destination queue.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.sqs#ChangeMessageVisibility": { "type": "operation", "input": { @@ -1335,7 +1394,7 @@ } ], "traits": { - "smithy.api#documentation": "Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
\nFor example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
\nLimits that apply to inflight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout \n for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
\nLimits that apply to in flight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility action) the next time the message is\n received.
Changes the visibility timeout of multiple messages. This is a batch version of \n ChangeMessageVisibility. The result of the action on each message is reported individually in the response. \n You can send up to 10 \n ChangeMessageVisibility\n requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility. The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n requests with each\n ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
A list of receipt handles of the messages for which the visibility timeout must be changed.
", + "smithy.api#documentation": "Lists the receipt handles of the messages for which the visibility timeout must be\n changed.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" @@ -1395,7 +1454,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An identifier for this particular receipt handle used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nAn identifier for this particular receipt handle used to communicate the\n result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nEncloses a receipt handle and an entry id for each message in \n ChangeMessageVisibilityBatch.\n
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
\n &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45\n
Encloses a receipt handle and an entry ID for each message in \n ChangeMessageVisibilityBatch.\n
A list of \n ChangeMessageVisibilityBatchResultEntry\n items.
A list of \n ChangeMessageVisibilityBatchResultEntry\n \n items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message\n succeeds or a \n BatchResultErrorEntry\n tag if the message\n fails.
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.
The receipt handle associated with the message, whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n \n action.
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
The new value for the message's visibility timeout (in seconds). Values range:\n 0 to 43200. Maximum: 12 hours.
Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nCreates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action.\n \n GetQueueUrl\n requires only the\n QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue returns an error.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", + "smithy.api#documentation": "The name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-), and\n underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO queue logic \n in the Amazon SQS Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" } @@ -1564,7 +1624,8 @@ } }, "traits": { - "smithy.api#documentation": "Returns the QueueUrl attribute of the created queue.
Returns the QueueUrl attribute of the created queue.
Deletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of \n DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage. The result of the action on each\n message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
A list of receipt handles for the messages to be deleted.
", + "smithy.api#documentation": "Lists the receipt handles for the messages to be deleted.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "DeleteMessageBatchRequestEntry" @@ -1644,7 +1705,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An identifier for this particular receipt handle. This is used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nFor each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted or a \n BatchResultErrorEntry\n tag if the message can't be deleted.
For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted\n or a \n BatchResultErrorEntry\n tag if the message can't be\n deleted.
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nDeletes the queue specified by the QueueUrl, regardless of the queue's\n contents.
Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET verb.
A list of attributes for which to retrieve information.
\nThe AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.\n
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed,\n ApproximateNumberOfMessagesNotVisible, and\n ApproximateNumberOfMessages metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate\n number of messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp – Returns the time when the queue was\n created in seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue\n was last changed in seconds (epoch time).
\n MaximumMessageSize – Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of\n time, in seconds, for which the ReceiveMessage action waits for a\n message to arrive.
\n VisibilityTimeout – Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds – Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } @@ -1831,7 +1893,8 @@ } }, "traits": { - "smithy.api#documentation": "A list of returned queue attributes.
" + "smithy.api#documentation": "A list of returned queue attributes.
", + "smithy.api#output": {} } }, "com.amazonaws.sqs#GetQueueUrl": { @@ -1848,7 +1911,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.\n
Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n \n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).
Queue URLs and names are case-sensitive.
", + "smithy.api#documentation": "The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens (-), and underscores\n (_).
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, @@ -1884,7 +1947,8 @@ } }, "traits": { - "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer Guide.
" + "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
", + "smithy.api#output": {} } }, "com.amazonaws.sqs#Integer": { @@ -1909,7 +1973,7 @@ "code": "AWS.SimpleQueueService.InvalidBatchEntryId", "httpResponseCode": 400 }, - "smithy.api#documentation": "The Id of a batch entry in a batch request doesn't abide by the specification.
The Id of a batch entry in a batch request doesn't abide by the\n specification.
Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set\n parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults, the\n response includes a maximum of 1,000 results. If you set MaxResults and\n there are additional results to display, the response includes a value for\n NextToken. Use NextToken as a parameter in your next\n request to ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1972,7 +2036,7 @@ "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
A list of source queue URLs that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
A list of your dead letter source queues.
" + "smithy.api#documentation": "A list of your dead letter source queues.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasks": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksRequest" + }, + "output": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Gets the most recent message movement tasks (up to 10) under a specific source\n queue.
" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksRequest": { + "type": "structure", + "members": { + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the queue whose message movement tasks are to be listed.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to include in the response. The default is 1, which\n provides the most recent message movement task. The upper limit is 10.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResult": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList", + "traits": { + "smithy.api#documentation": "A list of message movement tasks and their attributes.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "ListMessageMoveTasksResultEntry" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntry": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier associated with a message movement task. When this field is returned in\n the response of the ListMessageMoveTasks action, it is only populated for\n tasks that are in RUNNING status.
The status of the message movement task. Possible values are: RUNNING, COMPLETED,\n CANCELLING, CANCELLED, and FAILED.
" + } + }, + "SourceArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the queue that contains the messages to be moved to another queue.
" + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the destination queue if it has been specified in the\n StartMessageMoveTask request. If a DestinationArn has not\n been specified in the StartMessageMoveTask request, this field value will\n be NULL.
The number of messages to be moved per second (the message movement rate), if it has\n been specified in the StartMessageMoveTask request. If a\n MaxNumberOfMessagesPerSecond has not been specified in the\n StartMessageMoveTask request, this field value will be NULL.
The approximate number of messages already moved to the destination queue.
" + } + }, + "ApproximateNumberOfMessagesToMove": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of messages to be moved from the source queue. This number is obtained at\n the time of starting the message movement task.
" + } + }, + "FailureReason": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The task failure reason (only included if the task status is FAILED).
" + } + }, + "StartedTimestamp": { + "target": "com.amazonaws.sqs#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The timestamp of starting the message movement task.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the details of a message movement task.
" + } + }, + "com.amazonaws.sqs#ListMessageMoveTasksResultEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sqs#ListMessageMoveTasksResultEntry" } }, "com.amazonaws.sqs#ListQueueTags": { @@ -2013,7 +2208,7 @@ "target": "com.amazonaws.sqs#ListQueueTagsResult" }, "traits": { - "smithy.api#documentation": "List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nList all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues methods supports pagination. Set parameter\n MaxResults in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults, the response\n includes a maximum of 1,000 results. If you set MaxResults and there are\n additional results to display, the response includes a value for NextToken.\n Use NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" + "smithy.api#documentation": "A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" } }, "NextToken": { @@ -2080,7 +2278,7 @@ "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
", + "smithy.api#documentation": "A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in\n the request.
A list of your queues.
" + "smithy.api#documentation": "A list of your queues.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sqs#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 } }, "com.amazonaws.sqs#Message": { @@ -2117,13 +2322,13 @@ "MessageId": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.
A unique identifier for the message. A MessageIdis considered unique\n across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
" + "smithy.api#documentation": "An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.
" } }, "MD5OfBody": { @@ -2141,7 +2346,7 @@ "Attributes": { "target": "com.amazonaws.sqs#MessageSystemAttributeMap", "traits": { - "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n to their respective values. \n Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the \n epoch time in milliseconds.
A map of the attributes requested in \n ReceiveMessage\n to\n their respective values. Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each\n returned as an integer representing the epoch time in\n milliseconds.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" } }, "StringListValues": { @@ -2208,13 +2413,13 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (256 KiB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" } }, "StringListValues": { @@ -2379,13 +2590,13 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null.
The user-specified message system attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of inflight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of in flight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for\n 60 seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call\n PurgeQueue might be deleted while the queue is being purged.
Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
Indicates that the specified queue previously received a PurgeQueue\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
", + "smithy.api#documentation": "The URL of the queue from which the PurgeQueue action deletes\n messages.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } } @@ -2669,7 +2880,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.\n
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. \n If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon SQS Developer Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue \n is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nRetrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nA list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace\n header string.
\n SenderId\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.
\n SequenceNumber – Returns the value provided by\n Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
\nThe name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore\n (_), hyphen (-), and period\n (.).
The name is case-sensitive and must be unique among all attribute names for\n the message.
\nThe name must not start with AWS-reserved prefixes such as AWS.\n or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should\n not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All or\n .* in your request. You can also use all message attributes starting\n with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
" + "smithy.api#documentation": "The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" } }, "VisibilityTimeout": { "target": "com.amazonaws.sqs#Integer", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage requests is longer than the\n WaitTimeSeconds parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.
When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a\n ReceiveRequestAttemptId, Amazon SQS generates a\n ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no\n more messages belonging to the same MessageGroupId are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.
A list of received messages.
" + "smithy.api#documentation": "A list of received messages.
", + "smithy.api#output": {} } }, "com.amazonaws.sqs#RemovePermission": { @@ -2756,7 +2968,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Revokes any permissions in the queue policy that matches the specified\n Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The identification of the permission to remove. This is the label added using the \n AddPermission\n action.
The identification of the permission to remove. This is the label added using the\n \n AddPermission\n action.
One or more specified resources don't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, "com.amazonaws.sqs#SendMessage": { "type": "operation", "input": { @@ -2831,7 +3056,7 @@ } ], "traits": { - "smithy.api#documentation": "Delivers up to ten messages to the specified queue. This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
A list of \n BatchResultErrorEntry\n items with error details about each message that can't be enqueued.
A list of \n BatchResultErrorEntry\n items with error\n details about each message that can't be enqueued.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a\n \n BatchResultErrorEntry\n tag if the message\n fails.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. As SequenceNumber\n continues to increase for a particular MessageGroupId.
The message to send. The minimum size is one character. The maximum size is 256 KB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nThe message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n\n The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue applies.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any messages sent with the\n same MessageDeduplicationId are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n
An attribute containing the MessageId of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.
The MD5OfMessageBody and MessageId elements.
The MD5OfMessageBody and MessageId elements.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod is reduced\n below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies \n in the Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out)\n queues:
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" @@ -3139,6 +3366,68 @@ "smithy.api#input": {} } }, + "com.amazonaws.sqs#StartMessageMoveTask": { + "type": "operation", + "input": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskRequest" + }, + "output": { + "target": "com.amazonaws.sqs#StartMessageMoveTaskResult" + }, + "errors": [ + { + "target": "com.amazonaws.sqs#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Starts an asynchronous task to move messages from a specified source queue to a\n specified destination queue.
\nThis action is currently limited to supporting message redrive from\n dead-letter queues (DLQs) only. In this context, the source queue is the\n dead-letter queue (DLQ), while the destination queue can be the original\n source queue (from which the messages were driven to the dead-letter-queue),\n or a custom destination queue.
\nCurrently, only standard queues are supported.
\nOnly one active message movement task is supported per queue at any given\n time.
\nThe ARN of the queue that contains the messages to be moved to another queue.\n Currently, only dead-letter queue (DLQ) ARNs are accepted.
", + "smithy.api#required": {} + } + }, + "DestinationArn": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "The ARN of the queue that receives the moved messages. You can use this field to\n specify the destination queue where you would like to redrive messages. If this field is\n left blank, the messages will be redriven back to their respective original source\n queues.
" + } + }, + "MaxNumberOfMessagesPerSecond": { + "target": "com.amazonaws.sqs#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of messages to be moved per second (the message movement rate). You can use\n this field to define a fixed message movement rate. The maximum value for messages per\n second is 500. If this field is left blank, the system will optimize the rate based on\n the queue message backlog size, which may vary throughout the duration of the message\n movement task.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#StartMessageMoveTaskResult": { + "type": "structure", + "members": { + "TaskHandle": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#documentation": "An identifier associated with a message movement task. You can use this identifier to\n cancel a specified message movement task using the CancelMessageMoveTask\n action.
Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nReport configuration for a batch load task. This contains details about where error reports are stored.
" + "smithy.api#documentation": "Report configuration for a batch load task. This contains details about where error\n reports are stored.
" } }, "DataModelConfiguration": { "target": "com.amazonaws.timestreamwrite#DataModelConfiguration", "traits": { - "smithy.api#documentation": "Data model configuration for a batch load task. This contains details about where a data model for a batch load task is stored.
" + "smithy.api#documentation": "Data model configuration for a batch load task. This contains details about where a data\n model for a batch load task is stored.
" } }, "TargetDatabaseName": { @@ -376,7 +376,7 @@ "aws.api#clientDiscoveredEndpoint": { "required": true }, - "smithy.api#documentation": "Creates a new Timestream batch load task. A batch load task processes data from\n a CSV source in an S3 location and writes to a Timestream table. A mapping from\n source to target is defined in a batch load task. Errors and events are written to a report\n at an S3 location. For the report, if the KMS key is not specified, the\n batch load task will be encrypted with a Timestream managed KMS key\n located in your account. For more information, see Amazon Web Services managed\n keys. Service quotas apply. For\n details, see code\n sample.
" + "smithy.api#documentation": "Creates a new Timestream batch load task. A batch load task processes data from\n a CSV source in an S3 location and writes to a Timestream table. A mapping from\n source to target is defined in a batch load task. Errors and events are written to a report\n at an S3 location. For the report, if the KMS key is not specified, the\n report will be encrypted with an S3 managed key when SSE_S3 is the option.\n Otherwise an error is thrown. For more information, see Amazon Web Services managed\n keys. Service quotas apply. For\n details, see code\n sample.
Contains properties to set on the table when enabling magnetic store writes.
" } + }, + "Schema": { + "target": "com.amazonaws.timestreamwrite#Schema", + "traits": { + "smithy.api#documentation": "The schema of the table.
" + } } }, "traits": { @@ -1709,7 +1715,7 @@ "Value": { "target": "com.amazonaws.timestreamwrite#StringValue2048", "traits": { - "smithy.api#documentation": "The value for the MeasureValue.
", + "smithy.api#documentation": "The value for the MeasureValue. For information, see Data\n types.
", "smithy.api#required": {} } }, @@ -1909,6 +1915,78 @@ } } }, + "com.amazonaws.timestreamwrite#PartitionKey": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.timestreamwrite#PartitionKeyType", + "traits": { + "smithy.api#documentation": "The type of the partition key. Options are DIMENSION (dimension key) and MEASURE\n (measure key).
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.timestreamwrite#SchemaName", + "traits": { + "smithy.api#documentation": "The name of the attribute used for a dimension key.
" + } + }, + "EnforcementInRecord": { + "target": "com.amazonaws.timestreamwrite#PartitionKeyEnforcementLevel", + "traits": { + "smithy.api#documentation": "The level of enforcement for the specification of a dimension key in ingested records.\n Options are REQUIRED (dimension key must be specified) and OPTIONAL (dimension key does not\n have to be specified).
" + } + } + }, + "traits": { + "smithy.api#documentation": "An attribute used in partitioning data in a table. A dimension key partitions data\n using the values of the dimension specified by the dimension-name as partition key, while a\n measure key partitions data using measure names (values of the 'measure_name' column).\n
" + } + }, + "com.amazonaws.timestreamwrite#PartitionKeyEnforcementLevel": { + "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.timestreamwrite#PartitionKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.timestreamwrite#PartitionKey" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.timestreamwrite#PartitionKeyType": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, "com.amazonaws.timestreamwrite#Record": { "type": "structure", "members": { @@ -1933,7 +2011,7 @@ "MeasureValueType": { "target": "com.amazonaws.timestreamwrite#MeasureValueType", "traits": { - "smithy.api#documentation": " Contains the data type of the measure value for the time-series data point. Default\n type is DOUBLE.
Contains the data type of the measure value for the time-series data point. Default\n type is DOUBLE. For more information, see Data\n types.
Report configuration for a batch load task. This contains details about where error reports are stored.
" + "smithy.api#documentation": "Report configuration for a batch load task. This contains details about where error\n reports are stored.
" } }, "com.amazonaws.timestreamwrite#ReportS3Configuration": { @@ -2336,6 +2414,20 @@ } } }, + "com.amazonaws.timestreamwrite#Schema": { + "type": "structure", + "members": { + "CompositePartitionKey": { + "target": "com.amazonaws.timestreamwrite#PartitionKeyList", + "traits": { + "smithy.api#documentation": "A non-empty list of partition keys defining the attributes used to partition the table\n data. The order of the list determines the partition hierarchy. The name and type of each\n partition key as well as the partition key order cannot be changed after the table is\n created. However, the enforcement level of each partition key can be changed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A Schema specifies the expected data model of the table.
" + } + }, "com.amazonaws.timestreamwrite#SchemaName": { "type": "string", "traits": { @@ -2440,6 +2532,12 @@ "traits": { "smithy.api#documentation": "Contains properties to set on the table when enabling magnetic store writes.
" } + }, + "Schema": { + "target": "com.amazonaws.timestreamwrite#Schema", + "traits": { + "smithy.api#documentation": "The schema of the table.
" + } } }, "traits": { @@ -3586,6 +3684,12 @@ "traits": { "smithy.api#documentation": "Contains properties to set on the table when enabling magnetic store writes.
" } + }, + "Schema": { + "target": "com.amazonaws.timestreamwrite#Schema", + "traits": { + "smithy.api#documentation": "The schema of the table.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/verifiedpermissions.2021-12-01.json b/codegen/sdk-codegen/aws-models/verifiedpermissions.2021-12-01.json new file mode 100644 index 00000000000..4a1ea83e97f --- /dev/null +++ b/codegen/sdk-codegen/aws-models/verifiedpermissions.2021-12-01.json @@ -0,0 +1,4314 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.verifiedpermissions#AccessDeniedException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You don't have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.verifiedpermissions#ActionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#ActionIdentifier": { + "type": "structure", + "members": { + "actionType": { + "target": "com.amazonaws.verifiedpermissions#ActionType", + "traits": { + "smithy.api#documentation": "The type of an action.
", + "smithy.api#required": {} + } + }, + "actionId": { + "target": "com.amazonaws.verifiedpermissions#ActionId", + "traits": { + "smithy.api#documentation": "The ID of an action.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an action for a request for which an authorization decision\n is made.
\nThis data type is used as an request parameter to the IsAuthorized and IsAuthorizedWithToken operations.
\nExample: { \"actionId\": \"<action name>\", \"actionType\": \"Action\"\n }\n
An attribute value of Boolean\n type.
\nExample: {\"boolean\": true}\n
An attribute value of type EntityIdentifier.
\nExample: \"entityIdentifier\": { \"entityId\": \"<id>\", \"entityType\":\n \"<entity type>\"}\n
An attribute value of Long\n type.
\nExample: {\"long\": 0}\n
An attribute value of String\n type.
\nExample: {\"string\": \"abc\"}\n
An attribute value of Set\n type.
\nExample: {\"set\": [ {} ] }\n
An attribute value of Record\n type.
\nExample: {\"record\": { \"keyName\": {} } }\n
The value of an attribute.
\nContains information about the runtime context for a request for which an\n authorization decision is made.
\nThis data type is used as a member of the ContextDefinition structure\n which is uses as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.
" + } + }, + "com.amazonaws.verifiedpermissions#BooleanAttribute": { + "type": "boolean" + }, + "com.amazonaws.verifiedpermissions#ClientId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#ClientIds": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ClientId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.verifiedpermissions#CognitoUserPoolConfiguration": { + "type": "structure", + "members": { + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be\n authorized.
\nExample: \"UserPoolArn\":\n \"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\"\n
The unique application client IDs that are associated with the specified Amazon Cognito user\n pool.
\nExample: \"ClientIds\": [\"&ExampleCogClientId;\"]\n
The configuration for an identity source that represents a connection to an Amazon Cognito user pool used\n as an identity provider for Verified Permissions.
\nThis data type is used as a field that is part of an Configuration structure that is\n used as a parameter to the Configuration.
\nExample:\"CognitoUserPoolConfiguration\":{\"UserPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"ClientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}\n
Contains configuration details of a Amazon Cognito user pool that Verified Permissions can use as a source of\n authenticated identities as entities. It specifies the Amazon Resource Name (ARN) of a Amazon Cognito user pool\n and one or more application client IDs.
\nExample:\n \"configuration\":{\"cognitoUserPoolConfiguration\":{\"userPoolArn\":\"cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5\",\"clientIds\":\n [\"a1b2c3d4e5f6g7h8i9j0kalbmc\"]}}\n
Contains configuration information used when creating a new identity source.
\nAt this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.
\nYou must specify a userPoolArn, and optionally, a\n ClientId.
This data type is used as a request parameter for the CreateIdentitySource\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resources": { + "target": "com.amazonaws.verifiedpermissions#ResourceConflictList", + "traits": { + "smithy.api#documentation": "The list of resources referenced with this failed request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because another request to modify a resource occurred at the\n same.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.verifiedpermissions#ContextDefinition": { + "type": "union", + "members": { + "contextMap": { + "target": "com.amazonaws.verifiedpermissions#ContextMap", + "traits": { + "smithy.api#documentation": "An list of attributes that are needed to successfully evaluate an authorization\n request. Each attribute in this array must include a map of a data type and its\n value.
\nExample:\n \"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}\n
Contains additional details about the context of the request. Verified Permissions evaluates this\n information in an authorization request as part of the when and\n unless clauses in a policy.
This data type is used as a request parameter for the IsAuthorized and IsAuthorizedWithToken operations.
\nExample:\n \"context\":{\"Context\":{\"<KeyName1>\":{\"boolean\":true},\"<KeyName2>\":{\"long\":1234}}}\n
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nTo reference a user from this identity source in your Cedar policies, use the following\n syntax.
\n\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n
\nWhere IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.
Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies the ID of the policy store in which you want to store this identity source. Only policies and\n requests made using this policy store can reference identities from the identity provider\n configured in the new identity source.
", + "smithy.api#required": {} + } + }, + "configuration": { + "target": "com.amazonaws.verifiedpermissions#Configuration", + "traits": { + "smithy.api#documentation": "Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.
\nAt this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.
\nYou must specify a UserPoolArn, and optionally, a\n ClientId.
Specifies the namespace and data type of the principals generated for identities\n authenticated by the new identity source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreateIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the identity source was originally created.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "The unique ID of the new identity source.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the identity source was most recently updated.
", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the identity source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Cedar policy and save it in the specified policy store", + "smithy.api#documentation": "Creates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nSpecifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies the PolicyStoreId of the policy store you want to store the policy\n in.
A structure that specifies the policy type and content to use for the new policy. You\n must include either a static or a templateLinked element. The policy content must be written\n in the Cedar policy language.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the new policy.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The unique ID of the new policy.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "The policy type of the new policy.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal specified in the new policy's scope. This response element isn't present\n when principal isn't specified in the policy content.
The resource specified in the new policy's scope. This response element isn't present\n when the resource isn't specified in the policy content.
The date and time the policy was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a Cedar policy and save it in the specified policy store", + "smithy.api#documentation": "Creates a policy store. A policy store is a container for policy resources.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyStoreInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
Specifies the validation setting for this policy store.
\nCurrently, the only valid and required value is Mode.
We recommend that you turn on STRICT mode only after you define a\n schema. If a schema doesn't exist, then STRICT mode causes any policy\n to fail validation, and Verified Permissions rejects the policy. You can turn off validation by\n using the UpdatePolicyStore. Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.
The unique ID of the new policy store.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new policy store.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy store was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy store was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create a policy template", + "smithy.api#documentation": "Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplateInput": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.verifiedpermissions#IdempotencyToken", + "traits": { + "smithy.api#documentation": "Specifies a unique, case-sensitive ID that you provide to\n ensure the idempotency of the request. This lets you safely retry the request without\n accidentally performing the same operation a second time. Passing the same value to a\n later call to an operation requires that you also pass the same value for all other \n parameters. We recommend that you use a UUID type of \n value..
\nIf you don't provide this value, then Amazon Web Services generates a random one for\n you.
\nIf you retry the operation with the same ClientToken, but with \n different parameters, the retry fails with an IdempotentParameterMismatch\n error.
The ID of the policy store in which to create the policy template.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "Specifies a description for the policy template.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "Specifies the content that you want to use for the new policy template, written in the Cedar\n policy language.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#CreatePolicyTemplateOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the policy template.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The unique ID of the new policy template.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy template was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy template was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#Decision": { + "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.verifiedpermissions#DeleteIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete an identity source that references an identity provider (IdP) such as Amazon Cognito", + "smithy.api#documentation": "Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After\n you delete the identity source, you can no longer use tokens for identities from that identity source to\n represent principals in authorization queries made using IsAuthorizedWithToken.\n operations.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeleteIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the identity source that you want to delete.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the identity source that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeleteIdentitySourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy from the policy store", + "smithy.api#documentation": "Deletes the specified policy from the policy store.
\nThis operation is idempotent; if you specify a policy that doesn't \n exist, the request response returns a successful HTTP 200 status code.
Specifies the ID of the policy store that contains the policy that you want to delete.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStoreOutput" + }, + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy store", + "smithy.api#documentation": "Deletes the specified policy store.
\nThis operation is idempotent. If you specify a policy store that does not exist, the request\n response will still return a successful HTTP 200 status code.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyStoreOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to delete the specified policy template from the policy store", + "smithy.api#documentation": "Deletes the specified policy template from the policy store.
\nThis operation also deletes any policies that were created from the specified\n policy template. Those policies are immediately removed from all future API responses, and are\n asynchronously deleted from the policy store.
\nSpecifies the ID of the policy store that contains the policy template that you want to delete.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy template that you want to delete.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#DeletePolicyTemplateOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#DeterminingPolicyItem": { + "type": "structure", + "members": { + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The Id of a policy that determined to an authorization decision.
\nExample: \"policyId\":\"SPEXAMPLEabcdefg111111\"\n
Contains information about one of the policies that determined an authorization\n decision.
\nThis data type is used as an element in a response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.
\nExample: \"determiningPolicies\":[{\"policyId\":\"SPEXAMPLEabcdefg111111\"}]\n
An array of entities that are needed to successfully evaluate an authorization\n request. Each entity in this array must include an identifier for the entity, the\n attributes of the entity, and a list of any parent entities.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains the list of entities to be considered during an authorization request. This\n includes all principals, resources, and actions required to successfully evaluate the\n request.
\nThis data type is used as a field in the response parameter for the IsAuthorized\n and IsAuthorizedWithToken operations.
" + } + }, + "com.amazonaws.verifiedpermissions#EntityAttributes": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + }, + "traits": { + "smithy.api#length": { + "min": 0 + } + } + }, + "com.amazonaws.verifiedpermissions#EntityId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#EntityIdentifier": { + "type": "structure", + "members": { + "entityType": { + "target": "com.amazonaws.verifiedpermissions#EntityType", + "traits": { + "smithy.api#documentation": "The type of an entity.
\nExample: \"entityType\":\"typeName\"\n
The identifier of an entity.
\n\n \"entityId\":\"identifier\"\n
Contains the identifier of an entity, including its ID and type.
\nThis data type is used as a request parameter for IsAuthorized operation, and as a\n response parameter for the CreatePolicy, GetPolicy, and\n UpdatePolicy operations.
\nExample:\n {\"entityId\":\"string\",\"entityType\":\"string\"}\n
The identifier of the entity.
", + "smithy.api#required": {} + } + }, + "attributes": { + "target": "com.amazonaws.verifiedpermissions#EntityAttributes", + "traits": { + "smithy.api#documentation": "A list of attributes for the entity.
" + } + }, + "parents": { + "target": "com.amazonaws.verifiedpermissions#ParentList", + "traits": { + "smithy.api#documentation": "The parents in the hierarchy that contains the entity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an entity that can be referenced in a Cedar\n policy.
\nThis data type is used as one of the fields in the EntitiesDefinition\n structure.
\n\n {\n \"id\": {\n \"entityType\": \"Photo\",\n \"entityId\": \"VacationPhoto94.jpg\"\n },\n \"Attributes\": {},\n \"Parents\": [\n {\n \"entityType\": \"Album\",\n \"entityId\": \"alice_folder\"\n }\n ]\n}\n
Used to indicate that a principal or resource is not specified. This can be used to\n search for policies that are not associated with a specific principal or\n resource.
" + } + }, + "identifier": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The identifier of the entity. It can consist of either an EntityType and EntityId, a\n principal, or a resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a principal or resource that can be referenced in a Cedar\n policy.
\nThis data type is used as part of the PolicyFilter structure that is\n used as a request parameter for the ListPolicies operation..
" + } + }, + "com.amazonaws.verifiedpermissions#EntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#EvaluationErrorItem": { + "type": "structure", + "members": { + "errorDescription": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The error description.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a description of an evaluation error.
\nThis data type is used as a request parameter in the IsAuthorized and IsAuthorizedWithToken operations.
" + } + }, + "com.amazonaws.verifiedpermissions#EvaluationErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorItem" + }, + "traits": { + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySource": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySourceInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details about the specified identity source", + "smithy.api#documentation": "Retrieves the details about the specified identity source.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the identity source you want information about.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the identity source you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the identity source was originally created.
", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceDetails", + "traits": { + "smithy.api#documentation": "A structure that describes the configuration of the identity source.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "The ID of the identity source.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the identity source was most recently updated.
", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the identity source.
", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "The data type of principals generated for identities authenticated by this\n identity source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve information about the specified policy", + "smithy.api#documentation": "Retrieves information about the specified policy.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy that you want information\n about.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the policy that you want information about.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The unique ID of the policy that you want information about.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "The type of the policy.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.
The definition of the requested policy.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve details about a policy store", + "smithy.api#documentation": "Retrieves details about a policy store.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyStoreOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store;
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy store.
", + "smithy.api#required": {} + } + }, + "validationSettings": { + "target": "com.amazonaws.verifiedpermissions#ValidationSettings", + "traits": { + "smithy.api#documentation": "The current validation settings for the policy store.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy store was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy store was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified policy template in the specified policy store", + "smithy.api#documentation": "Retrieve the details for the specified policy template in the specified policy store.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplateInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy template that you want information\n about.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy template that you want information about.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetPolicyTemplateOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the policy template.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the policy template.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "The description of the policy template.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "The content of the body of the policy template written in the Cedar policy language.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy template was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "The date and time that the policy template was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#GetSchemaInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#GetSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to retrieve the details for the specified schema in the specified policy store", + "smithy.api#documentation": "Retrieve the details for the specified schema in the specified policy store.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchemaInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the schema.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#GetSchemaOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the schema.
", + "smithy.api#required": {} + } + }, + "schema": { + "target": "com.amazonaws.verifiedpermissions#SchemaJson", + "traits": { + "smithy.api#documentation": "The body of the schema, written in Cedar schema JSON.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the schema was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the schema was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#IdempotencyToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySource": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreateIdentitySource" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetIdentitySource" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdateIdentitySource" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeleteIdentitySource" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySources" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceDetails": { + "type": "structure", + "members": { + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" + } + }, + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool whose identities are accessible to this Verified Permissions\n policy store.
" + } + }, + "discoveryUrl": { + "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", + "traits": { + "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type is used as a response parameter for the CreateIdentitySource\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceFilter": { + "type": "structure", + "members": { + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "The Cedar entity type of the principals returned by the identity provider (IdP)\n associated with this identity source.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines characteristics of an identity source that you can use to\n filter.
\nThis data type is used as a request parameter for the ListIdentityStores\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceItem": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the identity source was originally created.
", + "smithy.api#required": {} + } + }, + "details": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails", + "traits": { + "smithy.api#documentation": "A structure that contains the details of the associated identity provider\n (IdP).
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "The unique identifier of the identity source.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the identity source was most recently updated.
", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The identifier of the policy store that contains the identity source.
", + "smithy.api#required": {} + } + }, + "principalEntityType": { + "target": "com.amazonaws.verifiedpermissions#PrincipalEntityType", + "traits": { + "smithy.api#documentation": "The Cedar entity type of the principals returned from the IdP associated with this\n identity source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that defines an identity source.
\nThis data type is used as a request parameter for the ListIdentityStores\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySourceItemDetails": { + "type": "structure", + "members": { + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "The application client IDs associated with the specified Amazon Cognito user pool that are\n enabled for this identity source.
" + } + }, + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "The Amazon Cognito user pool whose identities are accessible to this Verified Permissions policy store.
" + } + }, + "discoveryUrl": { + "target": "com.amazonaws.verifiedpermissions#DiscoveryUrl", + "traits": { + "smithy.api#documentation": "The well-known URL that points to this user pool's OIDC discovery endpoint. This is a\n URL string in the following format. This URL replaces the placeholders for both the\n Amazon Web Services Region and the user pool identifier with those appropriate for this user\n pool.
\n\n https://cognito-idp.<region>.amazonaws.com/<user-pool-id>/.well-known/openid-configuration\n
A string that identifies the type of OIDC service represented by this identity source.
\nAt this time, the only valid value is cognito.
A structure that contains configuration of the identity source.
\nThis data type is used as a response parameter for the CreateIdentitySource\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#IdentitySources": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceItem" + } + }, + "com.amazonaws.verifiedpermissions#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because of an internal error. Try your request again later
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorized": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to make an authorization decision about a service request described in the parameters", + "smithy.api#documentation": "Makes an authorization decision about a service request described in the parameters.\n The information in the parameters can also define additional context that Verified Permissions can\n include in the evaluation. The request is evaluated against all matching policies in the\n specified policy store. The result of the decision is either Allow or\n Deny, along with a list of the policies that resulted in the\n decision.
Specifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the principal for which the authorization decision is to be made.
" + } + }, + "action": { + "target": "com.amazonaws.verifiedpermissions#ActionIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the requested action to be authorized. For example, is the principal\n authorized to perform this action on the resource?
" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the resource for which the authorization decision is to be made.
" + } + }, + "context": { + "target": "com.amazonaws.verifiedpermissions#ContextDefinition", + "traits": { + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization\n decisions.
" + } + }, + "entities": { + "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", + "traits": { + "smithy.api#documentation": "Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedOutput": { + "type": "structure", + "members": { + "decision": { + "target": "com.amazonaws.verifiedpermissions#Decision", + "traits": { + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#required": {} + } + }, + "determiningPolicies": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", + "traits": { + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are two matching policies, where one is a forbid and the other is a permit,\n then the forbid policy will be the determining policy. In the case of multiple matching\n permit policies then there would be multiple determining policies. In the case that no\n policies match, and hence the response is DENY, there would be no determining\n policies.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", + "traits": { + "smithy.api#documentation": "Errors that occurred while making an authorization decision, for example, a policy\n references an Entity or entity Attribute that does not exist in the slice.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedWithToken": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to make an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source", + "smithy.api#documentation": "Makes an authorization decision about a service request described in the parameters.\n The principal in this request comes from an external identity source. The information in the\n parameters can also define additional context that Verified Permissions can include in the evaluation.\n The request is evaluated against all matching policies in the specified policy store. The result\n of the decision is either Allow or Deny, along with a list of\n the policies that resulted in the decision.
If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nSpecifies the ID of the policy store. Policies in this policy store will be used to make an\n authorization decision for the input.
", + "smithy.api#required": {} + } + }, + "identityToken": { + "target": "com.amazonaws.verifiedpermissions#Token", + "traits": { + "smithy.api#documentation": "Specifies an identity token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken or an IdentityToken, but not\n both.
Specifies an access token for the principal to be authorized. This token is provided\n to you by the identity provider (IdP) associated with the specified identity source. You must\n specify either an AccessToken or an IdentityToken, but not\n both.
Specifies the requested action to be authorized. Is the specified principal authorized\n to perform this action on the specified resource.
" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "Specifies the resource for which the authorization decision is made. For example, is\n the principal allowed to perform the action on the resource?
" + } + }, + "context": { + "target": "com.amazonaws.verifiedpermissions#ContextDefinition", + "traits": { + "smithy.api#documentation": "Specifies additional context that can be used to make more granular authorization\n decisions.
" + } + }, + "entities": { + "target": "com.amazonaws.verifiedpermissions#EntitiesDefinition", + "traits": { + "smithy.api#documentation": "Specifies the list of entities and their associated attributes that Verified Permissions can examine\n when evaluating the policies.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#IsAuthorizedWithTokenOutput": { + "type": "structure", + "members": { + "decision": { + "target": "com.amazonaws.verifiedpermissions#Decision", + "traits": { + "smithy.api#documentation": "An authorization decision that indicates if the authorization request should be\n allowed or denied.
", + "smithy.api#required": {} + } + }, + "determiningPolicies": { + "target": "com.amazonaws.verifiedpermissions#DeterminingPolicyList", + "traits": { + "smithy.api#documentation": "The list of determining policies used to make the authorization decision. For example,\n if there are multiple matching policies, where at least one is a forbid policy, then\n because forbid always overrides permit the forbid policies are the determining policies.\n If all matching policies are permit policies, then those policies are the determining\n policies. When no policies match and the response is the default DENY, there are no\n determining policies.
", + "smithy.api#required": {} + } + }, + "errors": { + "target": "com.amazonaws.verifiedpermissions#EvaluationErrorList", + "traits": { + "smithy.api#documentation": "Errors that occurred while making an authorization decision. For example, a policy\n references an entity or entity attribute that does not exist in the slice.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySources": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySourcesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListIdentitySourcesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all of the identity sources defined in the specified policy store", + "smithy.api#documentation": "Returns a paginated list of all of the identity sources defined in the specified policy store.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "identitySources" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the identity sources that you want to list.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies characteristics of an identity source that you can use to limit the output to matching\n identity sources.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.verifiedpermissions#ListIdentitySourcesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The list of identity sources stored in the specified policy store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicies": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPoliciesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPoliciesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policies stored in the specified policy store", + "smithy.api#documentation": "Returns a paginated list of all policies stored in the specified policy store.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policies" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPoliciesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store you want to list policies from.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
Specifies a filter that limits the response to only policies that match the specified\n criteria. For example, you list only the policies that reference a specified\n principal.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPoliciesOutput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
Lists all policies that are available in the specified policy store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStoresInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStoresOutput" + }, + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy stores in the calling Amazon Web Services account", + "smithy.api#documentation": "Returns a paginated list of all policy stores in the calling Amazon Web Services account.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policyStores" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyStoresInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The list of policy stores in the account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplatesInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplatesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to return a paginated list of all policy templates in the specified policy store", + "smithy.api#documentation": "Returns a paginated list of all policy templates in the specified policy store.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "policyTemplates" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.verifiedpermissions#ListPolicyTemplatesInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy templates you want to list.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.verifiedpermissions#NextToken", + "traits": { + "smithy.api#documentation": "Specifies that you want to receive the next page of results. Valid \n only if you received a NextToken response in the previous request. If you\n did, it indicates that more output is available. Set this parameter to the value \n provided by the previous call's NextToken response to request the \n next page of results.
Specifies the total number of results that you want included on each page \n of the response. If you do not include this parameter, it defaults to a value that is \n specific to the operation. If additional items exist beyond the number you specify, the\n NextToken response element is returned with a value (not null).\n Include the specified value as the NextToken request parameter in the next \n call to the operation to get the next part of the results. Note that the service might \n return fewer results than the maximum even when there are more results available. You \n should check NextToken after every operation to ensure that you receive all\n of the results.
If present, this value indicates that more output is available than \n is included in the current response. Use this value in the NextToken \n request parameter in a subsequent call to the operation to get the next part of the \n output. You should repeat this until the NextToken response element comes \n back as null. This indicates that this is the last page of results.
The list of the policy templates in the specified policy store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#LongAttribute": { + "type": "long" + }, + "com.amazonaws.verifiedpermissions#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.verifiedpermissions#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#NamespaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#Namespace" + } + }, + "com.amazonaws.verifiedpermissions#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8000 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_=+/\\.]*$" + } + }, + "com.amazonaws.verifiedpermissions#OpenIdIssuer": { + "type": "enum", + "members": { + "COGNITO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COGNITO" + } + } + } + }, + "com.amazonaws.verifiedpermissions#ParentList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.verifiedpermissions#Policy": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicy" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicy" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicy" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicy" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicies" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#PolicyDefinition": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinition", + "traits": { + "smithy.api#documentation": "A structure that describes a static policy. An static policy doesn't use a template or allow\n placeholders for entities.
" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition", + "traits": { + "smithy.api#documentation": "A structure that describes a policy that was instantiated from a template. The\n template can specify placeholders for principal and resource.\n When you use CreatePolicy to create a policy from a template, you specify the exact\n principal and resource to use for the instantiated policy.
A structure that contains the details for a Cedar policy definition. It includes the\n policy type, a description, and a policy body. This is a top level data type used to\n create a policy.
\nThis data type is used as a request parameter for the CreatePolicy operation. This\n structure must always have either an static or a templateLinked\n element.
Information about a static policy that wasn't created with a policy template.
" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionDetail", + "traits": { + "smithy.api#documentation": "Information about a template-linked policy that was created by instantiating a policy template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a policy definition. It must always have either an\n static or a templateLinked element.
This data type is used as a response parameter for the GetPolicy operation.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyDefinitionItem": { + "type": "union", + "members": { + "static": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "Information about a static policy that wasn't created with a policy template.
" + } + }, + "templateLinked": { + "target": "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "Information about a template-linked policy that was created by instantiating a policy template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes a PolicyDefinintion. It will\n always have either an StaticPolicy or a TemplateLinkedPolicy\n element.
This data type is used as a response parameter for the CreatePolicy and ListPolicies\n operations.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyFilter": { + "type": "structure", + "members": { + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityReference", + "traits": { + "smithy.api#documentation": "Filters the output to only policies that reference the specified principal.
" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityReference", + "traits": { + "smithy.api#documentation": "Filters the output to only policies that reference the specified resource.
" + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "Filters the output to only policies of the specified type.
" + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "Filters the output to only template-linked policies that were instantiated from the specified\n policy template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a filter to refine policies returned in a query.
\nThis data type is used as a response parameter for the ListPolicies operation.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The identifier of the PolicyStore where the policy you want information about is\n stored.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The identifier of the policy you want information about.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "The type of the policy. This is one of the following values:
\n\n static\n
\n templateLinked\n
The principal associated with the policy.
" + } + }, + "resource": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The resource associated with the policy.
" + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#PolicyDefinitionItem", + "traits": { + "smithy.api#documentation": "The policy definition of an item in the list of policies returned.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a policy.
\nThis data type is used as a response parameter for the ListPolicies operation.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.verifiedpermissions#PolicyStore": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyStore" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyStore" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStore" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyStore" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyStores" + }, + "operations": [ + { + "target": "com.amazonaws.verifiedpermissions#GetSchema" + }, + { + "target": "com.amazonaws.verifiedpermissions#IsAuthorized" + }, + { + "target": "com.amazonaws.verifiedpermissions#IsAuthorizedWithToken" + }, + { + "target": "com.amazonaws.verifiedpermissions#PutSchema" + } + ], + "resources": [ + { + "target": "com.amazonaws.verifiedpermissions#IdentitySource" + }, + { + "target": "com.amazonaws.verifiedpermissions#Policy" + }, + { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplate" + } + ], + "traits": { + "aws.api#arn": { + "template": "policy-store/{policyStoreId}", + "noRegion": true + }, + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "policy-store" + }, + "smithy.api#documentation": "Represents a policy store that you can place schema, policies, and policy templates in to validate authorization requests" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy store.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy store.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time the policy was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a policy store.
\nThis data type is used as a response parameter for the ListPolicyStores\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyStoreList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplate": { + "type": "resource", + "identifiers": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId" + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId" + } + }, + "create": { + "target": "com.amazonaws.verifiedpermissions#CreatePolicyTemplate" + }, + "read": { + "target": "com.amazonaws.verifiedpermissions#GetPolicyTemplate" + }, + "update": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplate" + }, + "delete": { + "target": "com.amazonaws.verifiedpermissions#DeletePolicyTemplate" + }, + "list": { + "target": "com.amazonaws.verifiedpermissions#ListPolicyTemplates" + }, + "traits": { + "aws.cloudformation#cfnResource": {}, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplateItem": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy store that contains the template.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy template.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "The description attached to the policy template.
" + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy template was created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy template was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains details about a policy template
\nThis data type is used as a response parameter for the ListPolicyTemplates\n operation.
" + } + }, + "com.amazonaws.verifiedpermissions#PolicyTemplatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateItem" + } + }, + "com.amazonaws.verifiedpermissions#PolicyType": { + "type": "enum", + "members": { + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATIC" + } + }, + "TEMPLATE_LINKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEMPLATE_LINKED" + } + } + } + }, + "com.amazonaws.verifiedpermissions#PrincipalEntityType": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.verifiedpermissions#PutSchema": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#PutSchemaInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#PutSchemaOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to create or update the policy schema in the specified policy store", + "smithy.api#documentation": "Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#PutSchemaInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store in which to place the schema.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#SchemaDefinition", + "traits": { + "smithy.api#documentation": "Specifies the definition of the schema to be stored. The schema definition must be\n written in Cedar schema JSON.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#PutSchemaOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The unique ID of the policy store that contains the schema.
", + "smithy.api#required": {} + } + }, + "namespaces": { + "target": "com.amazonaws.verifiedpermissions#NamespaceList", + "traits": { + "smithy.api#documentation": "Identifies the namespaces of the entities referenced by this schema.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the schema was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the schema was last updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#RecordAttribute": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + } + }, + "com.amazonaws.verifiedpermissions#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2500 + }, + "smithy.api#pattern": "^arn:[^:]*:[^:]*:[^:]*:[^:]*:.*$" + } + }, + "com.amazonaws.verifiedpermissions#ResourceConflict": { + "type": "structure", + "members": { + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique identifier of the resource involved in a conflict.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "The type of the resource involved in a conflict.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a resource conflict.
" + } + }, + "com.amazonaws.verifiedpermissions#ResourceConflictList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ResourceConflict" + } + }, + "com.amazonaws.verifiedpermissions#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "resourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The unique ID of the resource referenced in the failed request.
", + "smithy.api#required": {} + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the resource referenced in the failed request.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because it references a resource that doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.verifiedpermissions#ResourceType": { + "type": "enum", + "members": { + "IDENTITY_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IDENTITY_SOURCE" + } + }, + "POLICY_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_STORE" + } + }, + "POLICY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY" + } + }, + "POLICY_TEMPLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLICY_TEMPLATE" + } + }, + "SCHEMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEMA" + } + } + } + }, + "com.amazonaws.verifiedpermissions#SchemaDefinition": { + "type": "union", + "members": { + "cedarJson": { + "target": "com.amazonaws.verifiedpermissions#SchemaJson", + "traits": { + "smithy.api#documentation": "A JSON string representation of the schema supported by applications that use this\n policy store. For more information, see Policy store schema in the\n Amazon Verified Permissions User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a list of principal types, resource types, and actions that can be specified\n in policies stored in the same policy store. If the validation mode for the policy store is set to\n STRICT, then policies that can't be validated by this schema are\n rejected by Verified Permissions and can't be stored in the policy store.
The unique ID of the resource referenced in the failed request.
" + } + }, + "resourceType": { + "target": "com.amazonaws.verifiedpermissions#ResourceType", + "traits": { + "smithy.api#documentation": "The resource type of the resource referenced in the failed request.
", + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The code for the Amazon Web Service that owns the quota.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The quota code recognized by the Amazon Web Services Service Quotas service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because it would cause a service quota to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.verifiedpermissions#SetAttribute": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#AttributeValue" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinition": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "The description of the static policy.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "The policy content of the static policy, written in the Cedar policy language.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about a static policy.
\nThis data type is used as a field that is part of the PolicyDefinitionDetail\n type.
" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionDetail": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "A description of the static policy.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "The content of the static policy written in the Cedar policy language.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and\n policy body.
\nThis data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.
" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDefinitionItem": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "A description of the static policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains details about a static policy. It includes the description and\n policy statement.
\nThis data type is used within a PolicyDefinition structure as\n part of a request parameter for the CreatePolicy operation.
" + } + }, + "com.amazonaws.verifiedpermissions#StaticPolicyDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.verifiedpermissions#StringAttribute": { + "type": "string" + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinition": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy template used to create this policy.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
Contains information about a policy created by instantiating a policy template.
" + } + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionDetail": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy template used to create this policy.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
Contains information about a policy that was
\n \ncreated by instantiating a policy template.
\nThis
" + } + }, + "com.amazonaws.verifiedpermissions#TemplateLinkedPolicyDefinitionItem": { + "type": "structure", + "members": { + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The unique identifier of the policy template used to create this policy.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the\n ?principal placeholder in the policy template when it evaluates an authorization\n request.
The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the\n ?resource placeholder in the policy template when it evaluates an authorization\n request.
Contains information about a policy created by instantiating a policy template.
\nThis
" + } + }, + "com.amazonaws.verifiedpermissions#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "serviceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The code for the Amazon Web Service that owns the quota.
" + } + }, + "quotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The quota code recognized by the Amazon Web Services Service Quotas service.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because it exceeded a throttling quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.verifiedpermissions#TimestampFormat": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "date-time" + } + }, + "com.amazonaws.verifiedpermissions#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 131072 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+.[A-Za-z0-9-_=]+$" + } + }, + "com.amazonaws.verifiedpermissions#UpdateCognitoUserPoolConfiguration": { + "type": "structure", + "members": { + "userPoolArn": { + "target": "com.amazonaws.verifiedpermissions#UserPoolArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool associated with this identity source.
", + "smithy.api#required": {} + } + }, + "clientIds": { + "target": "com.amazonaws.verifiedpermissions#ClientIds", + "traits": { + "smithy.api#documentation": "The client ID of an app client that is configured for the specified Amazon Cognito user\n pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool for use with an identity source.
" + } + }, + "com.amazonaws.verifiedpermissions#UpdateConfiguration": { + "type": "union", + "members": { + "cognitoUserPoolConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateCognitoUserPoolConfiguration", + "traits": { + "smithy.api#documentation": "Contains configuration details of a Amazon Cognito user pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains an updated configuration to replace the configuration in an existing\n identity source.
\nAt this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.
\nYou must specify a userPoolArn, and optionally, a\n ClientId.
Updates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateIdentitySourceInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the identity source that you want to update.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the identity source that you want to update.
", + "smithy.api#required": {} + } + }, + "updateConfiguration": { + "target": "com.amazonaws.verifiedpermissions#UpdateConfiguration", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "Specifies the details required to communicate with the identity provider (IdP)\n associated with this identity source.
\nAt this time, the only valid member of this structure is a Amazon Cognito user pool\n configuration.
\nYou must specify a userPoolArn, and optionally, a\n ClientId.
Specifies the data type of principals generated for identities authenticated by the\n identity source.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateIdentitySourceOutput": { + "type": "structure", + "members": { + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the updated identity source was originally created.
", + "smithy.api#required": {} + } + }, + "identitySourceId": { + "target": "com.amazonaws.verifiedpermissions#IdentitySourceId", + "traits": { + "smithy.api#documentation": "The ID of the updated identity source.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the identity source was most recently updated.
", + "smithy.api#required": {} + } + }, + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the policy store that contains the updated identity source.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicy": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ServiceQuotaExceededException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to modify the specified Cedar static policy in the specified policy store", + "smithy.api#documentation": "Modifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to\n validate the policy against the schema in the policy store. If the updated static policy doesn't pass\n validation, the operation fails and the update isn't stored.
\nContains details about the updates to be applied to a static policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about updates to be applied to a policy.
\nThis data type is used as a request parameter in the UpdatePolicy operation.
" + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that contains the policy that you want to update.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy that you want to update. To find this value, you can\n use ListPolicies.
", + "smithy.api#required": {} + } + }, + "definition": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyDefinition", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "Specifies the updated policy content that you want to replace on the specified policy.\n The content must be valid Cedar policy language text.
\nYou can change only the following elements from the policy definition:
\nThe action referenced by the policy.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nChanging from static to templateLinked.
Changing the effect of the policy from permit or\n forbid.
The principal referenced by the policy.
The resource referenced by the policy.
The ID of the policy store that contains the policy that was updated.
", + "smithy.api#required": {} + } + }, + "policyId": { + "target": "com.amazonaws.verifiedpermissions#PolicyId", + "traits": { + "smithy.api#documentation": "The ID of the policy that was updated.
", + "smithy.api#required": {} + } + }, + "policyType": { + "target": "com.amazonaws.verifiedpermissions#PolicyType", + "traits": { + "smithy.api#documentation": "The type of the policy that was updated.
", + "smithy.api#required": {} + } + }, + "principal": { + "target": "com.amazonaws.verifiedpermissions#EntityIdentifier", + "traits": { + "smithy.api#documentation": "The principal specified in the policy's scope. This element isn't included in the\n response when Principal isn't present in the policy content.
The resource specified in the policy's scope. This element isn't included in the\n response when Resource isn't present in the policy content.
The date and time that the policy was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStoreInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyStoreOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to modify the validation setting for a policy store", + "smithy.api#documentation": "Modifies the validation setting for a policy store.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStoreInput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy store that you want to update
", + "smithy.api#required": {} + } + }, + "validationSettings": { + "target": "com.amazonaws.verifiedpermissions#ValidationSettings", + "traits": { + "smithy.api#documentation": "A structure that defines the validation settings that want to enable for the\n policy store.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyStoreOutput": { + "type": "structure", + "members": { + "policyStoreId": { + "target": "com.amazonaws.verifiedpermissions#PolicyStoreId", + "traits": { + "smithy.api#documentation": "The ID of the updated policy store.
", + "smithy.api#required": {} + } + }, + "arn": { + "target": "com.amazonaws.verifiedpermissions#ResourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the updated policy store.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy store was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy store was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdatePolicyTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateInput" + }, + "output": { + "target": "com.amazonaws.verifiedpermissions#UpdatePolicyTemplateOutput" + }, + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#ConflictException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ResourceNotFoundException" + } + ], + "traits": { + "aws.iam#actionPermissionDescription": "Grants permission to update the specified policy template", + "smithy.api#documentation": "Updates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately reflected in authorization\n decisions that involve all template-linked policies instantiated from this template.
\nSpecifies the ID of the policy store that contains the policy template that you want to update.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "Specifies the ID of the policy template that you want to update.
", + "smithy.api#required": {} + } + }, + "description": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateDescription", + "traits": { + "smithy.api#documentation": "Specifies a new description to apply to the policy template.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "Specifies new statement content written in Cedar policy language to replace the\n current body of the policy template.
\nYou can change only the following elements of the policy body:
\nThe action referenced by the policy template.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nThe effect (permit or forbid) of the policy template.
The principal referenced by the policy template.
The resource referenced by the policy template.
The ID of the policy store that contains the updated policy template.
", + "smithy.api#required": {} + } + }, + "policyTemplateId": { + "target": "com.amazonaws.verifiedpermissions#PolicyTemplateId", + "traits": { + "smithy.api#documentation": "The ID of the updated policy template.
", + "smithy.api#required": {} + } + }, + "createdDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy template was originally created.
", + "smithy.api#required": {} + } + }, + "lastUpdatedDate": { + "target": "com.amazonaws.verifiedpermissions#TimestampFormat", + "traits": { + "smithy.api#documentation": "The date and time that the policy template was most recently updated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.verifiedpermissions#UpdateStaticPolicyDefinition": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.verifiedpermissions#StaticPolicyDescription", + "traits": { + "smithy.api#documentation": "Specifies the description to be added to or replaced on the static policy.
" + } + }, + "statement": { + "target": "com.amazonaws.verifiedpermissions#PolicyStatement", + "traits": { + "smithy.api#documentation": "Specifies the Cedar policy language text to be added to or replaced on the static policy.
\nYou can change only the following elements from the original content:
\nThe action referenced by the policy.
Any conditional clauses, such as when or unless\n clauses.
You can't change the following elements:
\nChanging from StaticPolicy to\n TemplateLinkedPolicy.
The effect (permit or forbid) of the\n policy.
The principal referenced by the policy.
The resource referenced by the policy.
Contains information about an update to a static policy.
" + } + }, + "com.amazonaws.verifiedpermissions#UserPoolArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[a-zA-Z0-9-]+:cognito-idp:(([a-zA-Z0-9-]+:\\d{12}:userpool/[\\w-]+_[0-9a-zA-Z]+))$" + } + }, + "com.amazonaws.verifiedpermissions#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "fieldList": { + "target": "com.amazonaws.verifiedpermissions#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The list of fields that aren't valid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request failed because one or more input parameters don't satisfy their constraint\n requirements. The output is provided as a list of fields and a reason for each field that\n isn't valid.
\nThe possible reasons include the following:
\n\n UnrecognizedEntityType\n
\nThe policy includes an entity type that isn't found in the schema.
\n\n UnrecognizedActionId\n
\nThe policy includes an action id that isn't found in the schema.
\n\n InvalidActionApplication\n
\nThe policy includes an action that, according to the schema, doesn't support\n the specified principal and resource.
\n\n UnexpectedType\n
\nThe policy included an operand that isn't a valid type for the specified\n operation.
\n\n IncompatibleTypes\n
\nThe types of elements included in a set, or the types of\n expressions used in an if...then...else clause aren't compatible in\n this context.
\n MissingAttribute\n
\nThe policy attempts to access a record or entity attribute that isn't\n specified in the schema. Test for the existence of the attribute first before\n attempting to access its value. For more information, see the has (presence of attribute test) operator in the\n Cedar Policy Language Guide.
\n\n UnsafeOptionalAttributeAccess\n
\nThe policy attempts to access a record or entity attribute that is optional\n and isn't guaranteed to be present. Test for the existence of the attribute\n first before attempting to access its value. For more information, see the\n has (presence of attribute test) operator in the\n Cedar Policy Language Guide.
\n\n ImpossiblePolicy\n
\nCedar has determined that a policy condition always evaluates to false. If\n the policy is always false, it can never apply to any query, and so it can never\n affect an authorization decision.
\n\n WrongNumberArguments\n
\nThe policy references an extension type with the wrong number of\n arguments.
\n\n FunctionArgumentValidationError\n
\nCedar couldn't parse the argument passed to an extension type. For example,\n a string that is to be parsed as an IPv4 address can contain only digits and the\n period character.
\nThe path to the specific element that Verified Permissions found to be not valid.
", + "smithy.api#required": {} + } + }, + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Describes the policy validation error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details about a field that failed policy validation.
" + } + }, + "com.amazonaws.verifiedpermissions#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.verifiedpermissions#ValidationExceptionField" + } + }, + "com.amazonaws.verifiedpermissions#ValidationMode": { + "type": "enum", + "members": { + "OFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OFF" + } + }, + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICT" + } + } + } + }, + "com.amazonaws.verifiedpermissions#ValidationSettings": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.verifiedpermissions#ValidationMode", + "traits": { + "smithy.api#documentation": "The validation mode currently configured for this policy store. The valid values are:
\n\n OFF – Neither Verified Permissions nor Cedar\n perform any validation on policies. No validation errors are reported by either\n service.
\n\n STRICT – Requires a schema to be\n present in the policy store. Cedar performs validation on all submitted new or updated\n static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store\n them in the policy store.
\nIf Mode=STRICT and the policy store doesn't contain a schema, Verified Permissions rejects\n all static policies and policy templates because there is no schema to validate against.
To submit a static policy or policy template without a schema, you must turn off validation.
\nA structure that contains Cedar policy validation settings for the policy store. The\n validation mode determines which validation failures that Cedar considers serious\n enough to block acceptance of a new or edited static policy or policy template.
\nThis data type is used as a request parameter in the CreatePolicyStore and UpdatePolicyStore operations.
" + } + }, + "com.amazonaws.verifiedpermissions#VerifiedPermissions": { + "type": "service", + "version": "2021-12-01", + "resources": [ + { + "target": "com.amazonaws.verifiedpermissions#PolicyStore" + } + ], + "errors": [ + { + "target": "com.amazonaws.verifiedpermissions#AccessDeniedException" + }, + { + "target": "com.amazonaws.verifiedpermissions#InternalServerException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ThrottlingException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ThrottlingException" + }, + { + "target": "com.amazonaws.verifiedpermissions#ValidationException" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "VerifiedPermissions", + "arnNamespace": "verifiedpermissions", + "endpointPrefix": "verifiedpermissions" + }, + "aws.auth#sigv4": { + "name": "verifiedpermissions" + }, + "aws.iam#supportedPrincipalTypes": [ + "Root", + "IAMUser", + "IAMRole", + "FederatedUser" + ], + "aws.protocols#awsJson1_0": {}, + "smithy.api#documentation": "Amazon Verified Permissions is a permissions management service from Amazon Web Services. You can use Verified Permissions to manage\n permissions for your application, and authorize user access based on those permissions.\n Using Verified Permissions, application developers can grant access based on information about the\n users, resources, and requested actions. You can also evaluate additional information\n like group membership, attributes of the resources, and session context, such as time of\n request and IP addresses. Verified Permissions manages these permissions by letting you create and\n store authorization policies for your applications, such as consumer-facing web sites\n and enterprise business systems.
\nVerified Permissions uses Cedar as the policy language to express your permission requirements.\n Cedar supports both role-based access control (RBAC) and attribute-based access\n control (ABAC) authorization models.
\nFor more information about configuring, administering, and using Amazon Verified Permissions in your\n applications, see the Amazon Verified Permissions User Guide.
\nFor more information about the Cedar policy language, see the Cedar Policy Language Guide.
\nWhen you write Cedar policies that reference principals, resources and actions,\n you can define the unique identifiers used for each of those elements. We strongly\n recommend that you follow these best practices:
\n\n Use values like universally unique identifiers\n (UUIDs) for all principal and resource identifiers.\n
\nFor example, if user jane leaves the company, and you later\n let someone else use the name jane, then that new user\n automatically gets access to everything granted by policies that still\n reference User::\"jane\". Cedar can’t distinguish between the\n new user and the old. This applies to both principal and resource\n identifiers. Always use identifiers that are guaranteed unique and never\n reused to ensure that you don’t unintentionally grant access because of the\n presence of an old identifier in a policy.
Where you use a UUID for an entity, we recommend that you follow it with\n the // comment specifier and the ‘friendly’ name of your entity. This helps\n to make your policies easier to understand. For example: principal ==\n User::\"a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111\", // alice
\n\n Do not include personally identifying, confidential,\n or sensitive information as part of the unique identifier for your\n principals or resources. These identifiers are included in\n log entries shared in CloudTrail trails.
\nSeveral operations return structures that appear similar, but have different purposes.\n As new functionality is added to the product, the structure used in a parameter of one\n operation might need to change in a way that wouldn't make sense for the same parameter\n in a different operation. To help you understand the purpose of each, the following\n naming convention is used for the structures:
\nParameters that end in Detail are used in Get\n operations.
Parameters that end in Item are used in List\n operations.
Parameters that use neither suffix are used in the mutating (create and\n update) operations.
\nThe path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept POST requests.
For example, for the URL https://example.com/web/signup, you would provide the path /web/signup.
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
\nThis page must accept GET text/html requests.
For example, for the URL https://example.com/web/register, you would provide the path /web/register.
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
", + "smithy.api#required": {} + } + }, + "ResponseInspection": { + "target": "com.amazonaws.wafv2#ResponseInspection", + "traits": { + "smithy.api#documentation": "The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Allow the use of regular expressions in the registration page path and the account creation path.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet. This configuration is used in ManagedRuleGroupConfig.
The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
\nThe ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.
\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
" + } + }, + "EnableRegexInPath": { + "target": "com.amazonaws.wafv2#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Allow the use of regular expressions in the login page path.
" } } }, @@ -1644,6 +1693,27 @@ } } }, + "com.amazonaws.wafv2#AddressField": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.wafv2#FieldIdentifier", + "traits": { + "smithy.api#documentation": "The name of a single primary address field.
\nHow you specify the address fields depends on the request inspection payload type.
\nFor JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, \n the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.
The name of a field in the request payload that contains part or all of your customer's primary physical address.
\nThis data type is used in the RequestInspectionACFP data type.
The name of the email field.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, \n the email field specification is /form/email.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named email1, the email field specification is email1.
The name of the field in the request payload that contains your customer's email.
\nThis data type is used in the RequestInspectionACFP data type.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using commas and no added spaces.
\nMatches against the header order string are case insensitive.
" + "smithy.api#documentation": "Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.
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 \nin the WAF Developer Guide.
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 and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. 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 \nin the WAF Developer Guide.
Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using commas and no added spaces.
\nMatches against the header order string are case insensitive.
" + "smithy.api#documentation": "Inspect a string containing the list of the request's header names, ordered as they appear in the web request\nthat WAF receives for inspection. \n WAF generates the string and then uses that as the field to match component in its inspection. \n WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer.
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 REDACTED.
You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, Method, and\n JsonBody.
The parts of the request that you want to keep out of the logs.
\nFor example, if you\n redact the SingleHeader field, the HEADER field in the logs will\n be REDACTED for all rules that use the SingleHeader\n FieldToMatch setting.
Redaction applies only to the component that's specified in the rule's FieldToMatch setting, so the SingleHeader redaction \n doesn't apply to rules that use the Headers\n FieldToMatch.
You can specify only the following fields for redaction: UriPath,\n QueryString, SingleHeader, and Method.
Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet\n RequestInspection.
Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.
Additional configuration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. \n Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to login requests.
This configuration replaces the individual configuration fields in ManagedRuleGroupConfig and provides additional feature configuration.
For information \n about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group \n and WAF Fraud Control account takeover prevention (ATP)\n in the WAF Developer Guide.
" } + }, + "AWSManagedRulesACFPRuleSet": { + "target": "com.amazonaws.wafv2#AWSManagedRulesACFPRuleSet", + "traits": { + "smithy.api#documentation": "Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. \n Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide\n the information about how your distribution responds to account creation requests.
For information \n about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group \n and WAF Fraud Control account creation fraud prevention (ACFP)\n in the WAF Developer Guide.
" + } } }, "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nUse the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
" + "smithy.api#documentation": "Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nThe rule groups used for intelligent threat mitigation require additional configuration:
\nUse the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
" } }, "com.amazonaws.wafv2#ManagedRuleGroupConfigs": { @@ -8302,7 +8403,7 @@ "ManagedRuleGroupConfigs": { "target": "com.amazonaws.wafv2#ManagedRuleGroupConfigs", "traits": { - "smithy.api#documentation": "Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nUse the AWSManagedRulesATPRuleSet configuration object for the account takeover prevention managed rule group, to provide information such as the sign-in page of your application and the type of content to accept or reject from the client.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
\nThe rule groups used for intelligent threat mitigation require additional configuration:
\nUse the AWSManagedRulesACFPRuleSet configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.
Use the AWSManagedRulesATPRuleSet configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.
Use the AWSManagedRulesBotControlRuleSet configuration object to configure the \n protection level that you want the Bot Control rule group to use.
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.
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, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
The name of the password field. For example /form/password.
The name of the password field.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named password1, the password field specification is password1.
Details about your login page password field for request inspection, used in the \n AWSManagedRulesATPRuleSet\n RequestInspection configuration.
The name of the field in the request payload that contains your customer's password.
\nThis data type is used in the RequestInspection and RequestInspectionACFP data types.
The name of a single primary phone number field.
\nHow you specify the phone number fields depends on the request inspection payload type.
\nFor JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, \n the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.
The name of a field in the request payload that contains part or all of your customer's primary phone number.
\nThis data type is used in the RequestInspectionACFP data type.
Details about your login page username field.
\nHow you specify this depends on the payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"login\": { \"username\": \"THE_USERNAME\", \"password\": \"THE_PASSWORD\" } }, \n the username field specification is\n /login/username and the password field\n specification is /login/password.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named username1 and password1,\n the username field specification is\n username1 and the password field\n specification is password1.
The name of the field in the request payload that contains your customer's username.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n
Details about your login page password field.
\nHow you specify this depends on the payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"login\": { \"username\": \"THE_USERNAME\", \"password\": \"THE_PASSWORD\" } }, \n the username field specification is\n /login/username and the password field\n specification is /login/password.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named username1 and password1,\n the username field specification is\n username1 and the password field\n specification is password1.
The name of the field in the request payload that contains your customer's password.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named password1, the password field specification is password1.
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
\nThis is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.
In these settings, you specify how your application accepts login attempts\n by providing the request payload type and the names of the fields \n within the request body where the username and password are provided.
" } }, + "com.amazonaws.wafv2#RequestInspectionACFP": { + "type": "structure", + "members": { + "PayloadType": { + "target": "com.amazonaws.wafv2#PayloadType", + "traits": { + "smithy.api#documentation": "The payload type for your account creation endpoint, either JSON or form encoded.
", + "smithy.api#required": {} + } + }, + "UsernameField": { + "target": "com.amazonaws.wafv2#UsernameField", + "traits": { + "smithy.api#documentation": "The name of the field in the request payload that contains your customer's username.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n
The name of the field in the request payload that contains your customer's password.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"password\": \"THE_PASSWORD\" } }, \n the password field specification is /form/password.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named password1, the password field specification is password1.
The name of the field in the request payload that contains your customer's email.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"email\": \"THE_EMAIL\" } }, \n the email field specification is /form/email.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named email1, the email field specification is email1.
The names of the fields in the request payload that contain your customer's primary phone number.
\nOrder the phone number fields in the array exactly as they are ordered in the request payload.
\nHow you specify the phone number fields depends on the request inspection payload type.
\nFor JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"primaryphoneline1\": \"THE_PHONE1\", \"primaryphoneline2\": \"THE_PHONE2\", \"primaryphoneline3\": \"THE_PHONE3\" } }, \n the phone number field identifiers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number field identifiers are primaryphoneline1, primaryphoneline2, and primaryphoneline3.
The names of the fields in the request payload that contain your customer's primary physical address.
\nOrder the address fields in the array exactly as they are ordered in the request payload.
\nHow you specify the address fields depends on the request inspection payload type.
\nFor JSON payloads, specify the field identifiers in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"primaryaddressline1\": \"THE_ADDRESS1\", \"primaryaddressline2\": \"THE_ADDRESS2\", \"primaryaddressline3\": \"THE_ADDRESS3\" } }, \n the address field idenfiers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/primaryaddressline3.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with input elements\n named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address fields identifiers are primaryaddressline1, primaryaddressline2, and primaryaddressline3.
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
\nThis is part of the AWSManagedRulesACFPRuleSet configuration in ManagedRuleGroupConfig.
In these settings, you specify how your application accepts account creation attempts\n by providing the request payload type and the names of the fields \n within the request body where the username, password, email, and primary address and phone number fields are provided.
" + } + }, "com.amazonaws.wafv2#ResourceArn": { "type": "string", "traits": { @@ -10145,30 +10328,30 @@ "StatusCode": { "target": "com.amazonaws.wafv2#ResponseInspectionStatusCode", "traits": { - "smithy.api#documentation": "Configures inspection of the response status code.
" + "smithy.api#documentation": "Configures inspection of the response status code for success and failure indicators.
" } }, "Header": { "target": "com.amazonaws.wafv2#ResponseInspectionHeader", "traits": { - "smithy.api#documentation": "Configures inspection of the response header.
" + "smithy.api#documentation": "Configures inspection of the response header for success and failure indicators.
" } }, "BodyContains": { "target": "com.amazonaws.wafv2#ResponseInspectionBodyContains", "traits": { - "smithy.api#documentation": "Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
" + "smithy.api#documentation": "Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
" } }, "Json": { "target": "com.amazonaws.wafv2#ResponseInspectionJson", "traits": { - "smithy.api#documentation": "Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
" + "smithy.api#documentation": "Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
" } } }, "traits": { - "smithy.api#documentation": "The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
\nThe ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses that submit too many failed login attempts in a short amount of time.
\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThis is part of the AWSManagedRulesATPRuleSet configuration in ManagedRuleGroupConfig.
Enable login response inspection by configuring exactly one component of the response to inspect. You can't configure more than one. If you don't configure any of the response inspection options, response inspection is disabled.
" + "smithy.api#documentation": "The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.
\nResponse inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels \n and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.
\nThis is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet configurations in ManagedRuleGroupConfig.
Enable response inspection by configuring exactly one component of the response to inspect, for example, Header or StatusCode. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.
Strings in the body of the response that indicate a successful login attempt. To be counted as a successful login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
\nJSON example: \"SuccessStrings\": [ \"Login successful\", \"Welcome to our site!\" ]\n
Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
\nJSON examples: \"SuccessStrings\": [ \"Login successful\" ] and \"SuccessStrings\": [ \"Account creation successful\", \"Welcome to our site!\" ]\n
Strings in the body of the response that indicate a failed login attempt. To be counted as a failed login, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
\nJSON example: \"FailureStrings\": [ \"Login failed\" ]\n
Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
\nJSON example: \"FailureStrings\": [ \"Request failed\" ]\n
Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nConfigures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe name of the header to match against. The name must be an exact match, including case.
\nJSON example: \"Name\": [ \"LoginResult\" ]\n
The name of the header to match against. The name must be an exact match, including case.
\nJSON example: \"Name\": [ \"RequestResult\" ]\n
Values in the response header with the specified name that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ]\n
Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON examples: \"SuccessValues\": [ \"LoginPassed\", \"Successful login\" ] and \"SuccessValues\": [ \"AccountCreated\", \"Successful account creation\" ]\n
Values in the response header with the specified name that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ]\n
Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON examples: \"FailureValues\": [ \"LoginFailed\", \"Failed login\" ] and \"FailureValues\": [ \"AccountCreationFailed\" ]\n
Configures inspection of the response header. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nConfigures inspection of the response header. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nThe identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
\nJSON example: \"Identifier\": [ \"/login/success\" ]\n
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
\nJSON examples: \"Identifier\": [ \"/login/success\" ] and \"Identifier\": [ \"/sign-up/success\" ]\n
Values for the specified identifier in the response JSON that indicate a successful login attempt. To be counted as a successful login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]\n
Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"SuccessValues\": [ \"True\", \"Succeeded\" ]\n
Values for the specified identifier in the response JSON that indicate a failed login attempt. To be counted as a failed login, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"FailureValues\": [ \"False\", \"Failed\" ]\n
Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
\nJSON example: \"FailureValues\": [ \"False\", \"Failed\" ]\n
Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nConfigures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nStatus codes in the response that indicate a successful login attempt. To be counted as a successful login, the response status code must match one of these. Each code must be unique among the success and failure status codes.
\nJSON example: \"SuccessCodes\": [ 200, 201 ]\n
Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
\nJSON example: \"SuccessCodes\": [ 200, 201 ]\n
Status codes in the response that indicate a failed login attempt. To be counted as a failed login, the response status code must match one of these. Each code must be unique among the success and failure status codes.
\nJSON example: \"FailureCodes\": [ 400, 404 ]\n
Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
\nJSON example: \"FailureCodes\": [ 400, 404 ]\n
Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nConfigures inspection of the response status code. \n This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
\nA 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.
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, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see WAF Pricing.
The name of the username field. For example /form/username.
The name of the username field.
\nHow you specify this depends on the request inspection payload type.
\nFor JSON payloads, specify the field name in JSON\n pointer syntax. For information about the JSON Pointer\n syntax, see the Internet Engineering Task Force (IETF)\n documentation JavaScript\n \tObject Notation (JSON) Pointer.
\nFor example, for the JSON payload { \"form\": { \"username\": \"THE_USERNAME\" } }, \n the username field specification is /form/username.
For form encoded payload types, use the HTML form names.
\nFor example, for an HTML form with the input element\n named username1, the username field specification is\n username1\n
Details about your login page username field for request inspection, used in the \n AWSManagedRulesATPRuleSet\n RequestInspection configuration.
The name of the field in the request payload that contains your customer's username.
\nThis data type is used in the RequestInspection and RequestInspectionACFP data types.
The reason why a choice is non-applicable to a question in your workload.
" } + }, + "QuestionType": { + "target": "com.amazonaws.wellarchitected#QuestionType", + "traits": { + "smithy.api#documentation": "The type of the question.
" + } } }, "traits": { @@ -319,10 +325,73 @@ "smithy.api#input": {} } }, + "com.amazonaws.wellarchitected#AssociateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#AssociateProfilesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associate a profile with a workload.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/associateProfiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#AssociateProfilesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#ProfileArns", + "traits": { + "smithy.api#documentation": "The list of profile ARNs to associate with the workload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.wellarchitected#AwsAccountId": { "type": "string", "traits": { "smithy.api#documentation": "An Amazon Web Services account ID.
", + "smithy.api#length": { + "min": 12, + "max": 12 + }, "smithy.api#pattern": "^[0-9]{12}$" } }, @@ -910,7 +979,11 @@ "com.amazonaws.wellarchitected#ClientRequestToken": { "type": "string", "traits": { - "smithy.api#documentation": "A unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).
\nYou should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after the original request has completed\n successfully, the result of the original request is returned.
\nThis token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs\n automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,\n you must provide this token or the request will fail.
\nA unique case-sensitive string used to ensure that this request is idempotent\n (executes only once).
\nYou should not reuse the same token for other requests. If you retry a request with\n the same client request token and the same parameters after the original request has completed\n successfully, the result of the original request is returned.
\nThis token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs\n automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI,\n you must provide this token or the request will fail.
\nCreate a profile.
", + "smithy.api#http": { + "method": "POST", + "uri": "/profiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateProfileInput": { + "type": "structure", + "members": { + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "Name of the profile.
", + "smithy.api#required": {} + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "The profile description.
", + "smithy.api#required": {} + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "traits": { + "smithy.api#documentation": "The profile questions.
", + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the profile.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileOutput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "Version of the profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#CreateProfileShareInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#CreateProfileShareOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Create a profile share.
", + "smithy.api#http": { + "method": "POST", + "uri": "/profiles/{ProfileArn}/shares", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#CreateProfileShareInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith", + "traits": { + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#CreateProfileShareOutput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wellarchitected#CreateWorkload": { "type": "operation", "input": { @@ -1379,6 +1637,12 @@ "traits": { "smithy.api#documentation": "List of AppRegistry application ARNs associated to the workload.
" } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#WorkloadProfileArns", + "traits": { + "smithy.api#documentation": "The list of profile ARNs associated with the workload.
" + } } }, "traits": { @@ -1643,10 +1907,10 @@ "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DeleteWorkload": { + "com.amazonaws.wellarchitected#DeleteProfile": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + "target": "com.amazonaws.wellarchitected#DeleteProfileInput" }, "output": { "target": "smithy.api#Unit" @@ -1672,20 +1936,21 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing workload.
", + "smithy.api#documentation": "Delete a profile.
\n\n Disclaimer\n
\nBy sharing your profile with other Amazon Web Services accounts, \n you acknowledge that Amazon Web Services will make your profile available to those \n other accounts. Those other accounts may continue to access and use your \n shared profile even if you delete the profile \n from your own Amazon Web Services account or terminate \n your Amazon Web Services account.
\nThe profile ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1700,14 +1965,13 @@ } }, "traits": { - "smithy.api#documentation": "Input for workload deletion.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "com.amazonaws.wellarchitected#DeleteProfileShare": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + "target": "com.amazonaws.wellarchitected#DeleteProfileShareInput" }, "output": { "target": "smithy.api#Unit" @@ -1733,15 +1997,15 @@ } ], "traits": { - "smithy.api#documentation": "Delete a workload share.
", + "smithy.api#documentation": "Delete a profile share.
", "smithy.api#http": { "method": "DELETE", - "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "uri": "/profiles/{ProfileArn}/shares/{ShareId}", "code": 200 } } }, - "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "com.amazonaws.wellarchitected#DeleteProfileShareInput": { "type": "structure", "members": { "ShareId": { @@ -1751,9 +2015,10 @@ "smithy.api#required": {} } }, - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { + "smithy.api#documentation": "The profile ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1768,37 +2033,165 @@ } }, "traits": { - "smithy.api#documentation": "Input for Delete Workload Share
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#DifferenceStatus": { - "type": "enum", - "members": { - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "NEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.wellarchitected#DisassociateLenses": { + "com.amazonaws.wellarchitected#DeleteWorkload": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" + "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete an existing workload.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for workload deletion.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Delete a workload share.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/workloads/{WorkloadId}/shares/{ShareId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { + "type": "structure", + "members": { + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#httpQuery": "ClientRequestToken", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input for Delete Workload Share
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#DifferenceStatus": { + "type": "enum", + "members": { + "UPDATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATED" + } + }, + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.wellarchitected#DisassociateLenses": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" }, "output": { "target": "smithy.api#Unit" @@ -1854,6 +2247,65 @@ "smithy.api#input": {} } }, + "com.amazonaws.wellarchitected#DisassociateProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#DisassociateProfilesInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociate a profile from a workload.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/workloads/{WorkloadId}/disassociateProfiles", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#DisassociateProfilesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArns": { + "target": "com.amazonaws.wellarchitected#ProfileArns", + "traits": { + "smithy.api#documentation": "The list of profile ARNs to disassociate from the workload.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { "type": "enum", "members": { @@ -2600,13 +3052,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#GetWorkload": { + "com.amazonaws.wellarchitected#GetProfile": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + "target": "com.amazonaws.wellarchitected#GetProfileInput" }, "output": { - "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + "target": "com.amazonaws.wellarchitected#GetProfileOutput" }, "errors": [ { @@ -2626,76 +3078,69 @@ } ], "traits": { - "smithy.api#documentation": "Get an existing workload.
", + "smithy.api#documentation": "Get profile information.
", "smithy.api#http": { "method": "GET", - "uri": "/workloads/{WorkloadId}", + "uri": "/profiles/{ProfileArn}", "code": 200 } } }, - "com.amazonaws.wellarchitected#GetWorkloadInput": { + "com.amazonaws.wellarchitected#GetProfileInput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { + "smithy.api#documentation": "The profile ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The profile version.
", + "smithy.api#httpQuery": "ProfileVersion" + } } }, "traits": { - "smithy.api#documentation": "Input to get a workload.
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#GetWorkloadOutput": { + "com.amazonaws.wellarchitected#GetProfileOutput": { "type": "structure", "members": { - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" + "Profile": { + "target": "com.amazonaws.wellarchitected#Profile", + "traits": { + "smithy.api#documentation": "The profile.
" + } } }, "traits": { - "smithy.api#documentation": "Output of a get workload call.
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#HelpfulResourceUrl": { - "type": "string", - "traits": { - "smithy.api#documentation": "The helpful resource URL.
\nFor Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
\nFor custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.
Import a new custom lens or update an existing custom lens.
\nTo update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.
\nA custom lens cannot exceed 500 KB in size.
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nGet profile template.
", "smithy.api#http": { - "method": "PUT", - "uri": "/importLens", + "method": "GET", + "uri": "/profileTemplate", "code": 200 } } }, - "com.amazonaws.wellarchitected#ImportLensInput": { + "com.amazonaws.wellarchitected#GetProfileTemplateInput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetProfileTemplateOutput": { "type": "structure", "members": { - "LensAlias": { - "target": "com.amazonaws.wellarchitected#LensAlias" - }, - "JSONString": { - "target": "com.amazonaws.wellarchitected#LensJSON", + "ProfileTemplate": { + "target": "com.amazonaws.wellarchitected#ProfileTemplate", + "traits": { + "smithy.api#documentation": "The profile template.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#GetWorkload": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#GetWorkloadInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Get an existing workload.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#GetWorkloadInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Input to get a workload.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#GetWorkloadOutput": { + "type": "structure", + "members": { + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "Output of a get workload call.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#HelpfulResourceUrl": { + "type": "string", + "traits": { + "smithy.api#documentation": "The helpful resource URL.
\nFor Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
\nFor custom lenses, this is the helpful resource URL for a question and is only provided\n if HelpfulResourceDisplayText was specified for the question.
Import a new custom lens or update an existing custom lens.
\nTo update an existing custom lens, specify its ARN as the LensAlias. If\n no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be\n applied to workloads or shared with other Amazon Web Services accounts until it's\n published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification \n in the Well-Architected Tool User Guide.
\nA custom lens cannot exceed 500 KB in size.
\n\n Disclaimer\n
\nDo not include or gather personal identifiable information (PII) of end users or \n other identifiable individuals in or via your custom lenses. If your custom \n lens or those shared with you and used in your account do include or collect \n PII you are responsible for: ensuring that the included PII is processed in accordance \n with applicable law, providing adequate privacy notices, and obtaining necessary \n consents for processing such data.
\nThe JSON representation of a lens.
", "smithy.api#required": {} @@ -3055,6 +3633,15 @@ }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "The profiles associated with the workload.
" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { @@ -3122,6 +3709,15 @@ }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "The profiles associated with the workload.
" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { @@ -3432,6 +4028,13 @@ "smithy.api#documentation": "The maximum number of results to return for this request.
", "smithy.api#httpQuery": "MaxResults" } + }, + "QuestionPriority": { + "target": "com.amazonaws.wellarchitected#QuestionPriority", + "traits": { + "smithy.api#documentation": "The priority of the question.
", + "smithy.api#httpQuery": "QuestionPriority" + } } }, "traits": { @@ -3774,6 +4377,13 @@ "smithy.api#documentation": "The maximum number of results to return for this request.
", "smithy.api#httpQuery": "MaxResults" } + }, + "QuestionPriority": { + "target": "com.amazonaws.wellarchitected#QuestionPriority", + "traits": { + "smithy.api#documentation": "The priority of the question.
", + "smithy.api#httpQuery": "QuestionPriority" + } } }, "traits": { @@ -4280,13 +4890,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListShareInvitations": { + "com.amazonaws.wellarchitected#ListProfileNotifications": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" + "target": "com.amazonaws.wellarchitected#ListProfileNotificationsInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" + "target": "com.amazonaws.wellarchitected#ListProfileNotificationsOutput" }, "errors": [ { @@ -4303,10 +4913,10 @@ } ], "traits": { - "smithy.api#documentation": "List the workload invitations.
", + "smithy.api#documentation": "List profile notifications.
", "smithy.api#http": { "method": "GET", - "uri": "/shareInvitations", + "uri": "/profileNotifications", "code": 200 }, "smithy.api#paginated": { @@ -4316,27 +4926,13 @@ } } }, - "com.amazonaws.wellarchitected#ListShareInvitationsInput": { + "com.amazonaws.wellarchitected#ListProfileNotificationsInput": { "type": "structure", "members": { - "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", - "traits": { - "smithy.api#httpQuery": "WorkloadNamePrefix" - } - }, - "LensNamePrefix": { - "target": "com.amazonaws.wellarchitected#LensNamePrefix", - "traits": { - "smithy.api#documentation": "An optional string added to the beginning of each lens name returned in the results.
", - "smithy.api#httpQuery": "LensNamePrefix" - } - }, - "ShareResourceType": { - "target": "com.amazonaws.wellarchitected#ShareResourceType", + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { - "smithy.api#documentation": "The type of share invitations to be returned.
", - "smithy.api#httpQuery": "ShareResourceType" + "smithy.api#httpQuery": "WorkloadId" } }, "NextToken": { @@ -4346,108 +4942,41 @@ } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", + "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for this request.
", "smithy.api#httpQuery": "MaxResults" } } }, "traits": { - "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { + "com.amazonaws.wellarchitected#ListProfileNotificationsOutput": { "type": "structure", "members": { - "ShareInvitationSummaries": { - "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "NotificationSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileNotificationSummaries", "traits": { - "smithy.api#documentation": "List of share invitation summaries in a workload.
" + "smithy.api#documentation": "Notification summaries.
" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, - "traits": { - "smithy.api#documentation": "Input for List Share Invitations
", - "smithy.api#output": {} - } - }, - "com.amazonaws.wellarchitected#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.wellarchitected#InternalServerException" - }, - { - "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "List the tags for a resource.
\nThe WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
\nThe tags for the resource.
" - } - } - }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadShares": { + "com.amazonaws.wellarchitected#ListProfileShares": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + "target": "com.amazonaws.wellarchitected#ListProfileSharesInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + "target": "com.amazonaws.wellarchitected#ListProfileSharesOutput" }, "errors": [ { @@ -4467,10 +4996,10 @@ } ], "traits": { - "smithy.api#documentation": "List the workload shares associated with the workload.
", + "smithy.api#documentation": "List profile shares.
", "smithy.api#http": { "method": "GET", - "uri": "/workloads/{WorkloadId}/shares", + "uri": "/profiles/{ProfileArn}/shares", "code": 200 }, "smithy.api#paginated": { @@ -4480,12 +5009,13 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { + "com.amazonaws.wellarchitected#ListProfileSharesInput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId", + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { + "smithy.api#documentation": "The profile ARN.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4493,7 +5023,7 @@ "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.
", "smithy.api#httpQuery": "SharedWithPrefix" } }, @@ -4504,7 +5034,7 @@ } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "target": "com.amazonaws.wellarchitected#ListProfileSharesMaxResults", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum number of results to return for this request.
", @@ -4519,11 +5049,10 @@ } }, "traits": { - "smithy.api#documentation": "Input for List Workload Share
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "com.amazonaws.wellarchitected#ListProfileSharesMaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, @@ -4533,31 +5062,118 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "com.amazonaws.wellarchitected#ListProfileSharesOutput": { "type": "structure", "members": { - "WorkloadId": { - "target": "com.amazonaws.wellarchitected#WorkloadId" + "ProfileShareSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileShareSummaries", + "traits": { + "smithy.api#documentation": "Profile share summaries.
" + } }, - "WorkloadShareSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListProfilesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListProfilesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List profiles.
", + "smithy.api#http": { + "method": "GET", + "uri": "/profileSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListProfilesInput": { + "type": "structure", + "members": { + "ProfileNamePrefix": { + "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", + "traits": { + "smithy.api#documentation": "Prefix for profile name.
", + "smithy.api#httpQuery": "ProfileNamePrefix" + } + }, + "ProfileOwnerType": { + "target": "com.amazonaws.wellarchitected#ProfileOwnerType", + "traits": { + "smithy.api#documentation": "Profile owner type.
", + "smithy.api#httpQuery": "ProfileOwnerType" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#httpQuery": "MaxResults" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListProfilesOutput": { + "type": "structure", + "members": { + "ProfileSummaries": { + "target": "com.amazonaws.wellarchitected#ProfileSummaries", + "traits": { + "smithy.api#documentation": "Profile summaries.
" + } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { - "smithy.api#documentation": "Input for List Workload Share
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#ListWorkloads": { + "com.amazonaws.wellarchitected#ListShareInvitations": { "type": "operation", "input": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" }, "output": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" }, "errors": [ { @@ -4574,10 +5190,10 @@ } ], "traits": { - "smithy.api#documentation": "Paginated list of workloads.
", + "smithy.api#documentation": "List the workload invitations.
", "smithy.api#http": { - "method": "POST", - "uri": "/workloadsSummaries", + "method": "GET", + "uri": "/shareInvitations", "code": 200 }, "smithy.api#paginated": { @@ -4587,29 +5203,57 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "com.amazonaws.wellarchitected#ListShareInvitationsInput": { "type": "structure", "members": { "WorkloadNamePrefix": { - "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", + "traits": { + "smithy.api#httpQuery": "WorkloadNamePrefix" + } + }, + "LensNamePrefix": { + "target": "com.amazonaws.wellarchitected#LensNamePrefix", + "traits": { + "smithy.api#documentation": "An optional string added to the beginning of each lens name returned in the results.
", + "smithy.api#httpQuery": "LensNamePrefix" + } + }, + "ShareResourceType": { + "target": "com.amazonaws.wellarchitected#ShareResourceType", + "traits": { + "smithy.api#documentation": "The type of share invitations to be returned.
", + "smithy.api#httpQuery": "ShareResourceType" + } }, "NextToken": { - "target": "com.amazonaws.wellarchitected#NextToken" + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } }, "MaxResults": { - "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "target": "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for this request.
" + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "ProfileNamePrefix": { + "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", + "traits": { + "smithy.api#documentation": "Profile name prefix.
", + "smithy.api#httpQuery": "ProfileNamePrefix" } } }, "traits": { - "smithy.api#documentation": "Input to list all workloads.
", + "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#input": {} } }, - "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "com.amazonaws.wellarchitected#ListShareInvitationsMaxResults": { "type": "integer", "traits": { "smithy.api#default": 0, @@ -4619,332 +5263,1064 @@ } } }, - "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { "type": "structure", "members": { - "WorkloadSummaries": { - "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + "ShareInvitationSummaries": { + "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", + "traits": { + "smithy.api#documentation": "List of share invitation summaries in a workload.
" + } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { - "smithy.api#documentation": "Output of a list workloads call.
", + "smithy.api#documentation": "Input for List Share Invitations
", "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#MaxResults": { - "type": "integer", + "com.amazonaws.wellarchitected#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + } + ], "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The maximum number of results to return for this request.
", - "smithy.api#range": { - "min": 1, - "max": 50 + "smithy.api#documentation": "List the tags for a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nThe tags for the resource.
" } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName" - }, - "RecordedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" - }, - "Workload": { - "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { - "smithy.api#documentation": "A milestone return object.
" + "smithy.api#output": {} } }, - "com.amazonaws.wellarchitected#MilestoneName": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the milestone in a workload.
\nMilestone names must be unique within a workload.
", - "smithy.api#length": { - "min": 3, - "max": 100 + "com.amazonaws.wellarchitected#ListWorkloadShares": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" } - } - }, - "com.amazonaws.wellarchitected#MilestoneNumber": { - "type": "integer", + ], "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The milestone number.
\nA workload can have a maximum of 100 milestones.
", - "smithy.api#range": { - "min": 1, - "max": 100 + "smithy.api#documentation": "List the workload shares associated with the workload.
", + "smithy.api#http": { + "method": "GET", + "uri": "/workloads/{WorkloadId}/shares", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" } } }, - "com.amazonaws.wellarchitected#MilestoneSummaries": { + "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SharedWithPrefix": { + "target": "com.amazonaws.wellarchitected#SharedWithPrefix", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
", + "smithy.api#httpQuery": "SharedWithPrefix" + } + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken", + "traits": { + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus", + "traits": { + "smithy.api#httpQuery": "Status" + } + } + }, + "traits": { + "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadShareSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "Input for List Workload Share
", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloads": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" + }, + "output": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Paginated list of workloads.
", + "smithy.api#http": { + "method": "POST", + "uri": "/workloadsSummaries", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsInput": { + "type": "structure", + "members": { + "WorkloadNamePrefix": { + "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + }, + "MaxResults": { + "target": "com.amazonaws.wellarchitected#ListWorkloadsMaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Input to list all workloads.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#ListWorkloadsOutput": { + "type": "structure", + "members": { + "WorkloadSummaries": { + "target": "com.amazonaws.wellarchitected#WorkloadSummaries" + }, + "NextToken": { + "target": "com.amazonaws.wellarchitected#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "Output of a list workloads call.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.wellarchitected#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of results to return for this request.
", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.wellarchitected#MaxSelectedProfileChoices": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#MetricType": { + "type": "enum", + "members": { + "WORKLOAD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKLOAD" + } + } + } + }, + "com.amazonaws.wellarchitected#Milestone": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "Workload": { + "target": "com.amazonaws.wellarchitected#Workload" + } + }, + "traits": { + "smithy.api#documentation": "A milestone return object.
" + } + }, + "com.amazonaws.wellarchitected#MilestoneName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the milestone in a workload.
\nMilestone names must be unique within a workload.
", + "smithy.api#length": { + "min": 3, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneNumber": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The milestone number.
\nA workload can have a maximum of 100 milestones.
", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.wellarchitected#MilestoneSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#MilestoneSummary" + }, + "traits": { + "smithy.api#documentation": "A list of milestone summaries.
" + } + }, + "com.amazonaws.wellarchitected#MilestoneSummary": { + "type": "structure", + "members": { + "MilestoneNumber": { + "target": "com.amazonaws.wellarchitected#MilestoneNumber", + "traits": { + "smithy.api#default": 0 + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "RecordedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "WorkloadSummary": { + "target": "com.amazonaws.wellarchitected#WorkloadSummary" + } + }, + "traits": { + "smithy.api#documentation": "A milestone summary return object.
" + } + }, + "com.amazonaws.wellarchitected#MinSelectedProfileChoices": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.wellarchitected#NextToken": { + "type": "string", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next set of results.
" + } + }, + "com.amazonaws.wellarchitected#Notes": { + "type": "string", + "traits": { + "smithy.api#documentation": "The notes associated with the workload.
", + "smithy.api#length": { + "min": 0, + "max": 2084 + } + } + }, + "com.amazonaws.wellarchitected#NotificationSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#NotificationSummary" + } + }, + "com.amazonaws.wellarchitected#NotificationSummary": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.wellarchitected#NotificationType", + "traits": { + "smithy.api#documentation": "The type of notification.
" + } + }, + "LensUpgradeSummary": { + "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", + "traits": { + "smithy.api#documentation": "Summary of lens upgrade.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A notification summary return object.
" + } + }, + "com.amazonaws.wellarchitected#NotificationType": { + "type": "enum", + "members": { + "LENS_VERSION_UPGRADED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS_VERSION_UPGRADED" + } + }, + "LENS_VERSION_DEPRECATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENS_VERSION_DEPRECATED" + } + } + } + }, + "com.amazonaws.wellarchitected#OrganizationSharingStatus": { + "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.wellarchitected#PermissionType": { + "type": "enum", + "members": { + "READONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READONLY" + } + }, + "CONTRIBUTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTOR" + } + } + }, + "traits": { + "smithy.api#documentation": "Permission granted on a share request.
" + } + }, + "com.amazonaws.wellarchitected#PillarDifference": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "DifferenceStatus": { + "target": "com.amazonaws.wellarchitected#DifferenceStatus", + "traits": { + "smithy.api#documentation": "Indicates the type of change to the pillar.
" + } + }, + "QuestionDifferences": { + "target": "com.amazonaws.wellarchitected#QuestionDifferences", + "traits": { + "smithy.api#documentation": "List of question differences.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A pillar difference return object.
" + } + }, + "com.amazonaws.wellarchitected#PillarDifferences": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarDifference" + } + }, + "com.amazonaws.wellarchitected#PillarId": { + "type": "string", + "traits": { + "smithy.api#documentation": "The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.wellarchitected#PillarMetric": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "Questions": { + "target": "com.amazonaws.wellarchitected#QuestionMetrics", + "traits": { + "smithy.api#documentation": "The questions that have been identified as risks in the pillar.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A metric for a particular pillar in a lens.
" + } + }, + "com.amazonaws.wellarchitected#PillarMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarMetric" + } + }, + "com.amazonaws.wellarchitected#PillarName": { + "type": "string", + "traits": { + "smithy.api#documentation": "The name of the pillar.
", + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.wellarchitected#PillarNotes": { + "type": "map", + "key": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "value": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "traits": { + "smithy.api#documentation": "List of pillar notes of a lens review in a workload.
" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#PillarReviewSummary" + }, + "traits": { + "smithy.api#documentation": "List of pillar review summaries of lens review in a workload.
" + } + }, + "com.amazonaws.wellarchitected#PillarReviewSummary": { + "type": "structure", + "members": { + "PillarId": { + "target": "com.amazonaws.wellarchitected#PillarId" + }, + "PillarName": { + "target": "com.amazonaws.wellarchitected#PillarName" + }, + "Notes": { + "target": "com.amazonaws.wellarchitected#Notes" + }, + "RiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" + } + }, + "traits": { + "smithy.api#documentation": "A pillar review summary of a lens review.
" + } + }, + "com.amazonaws.wellarchitected#Profile": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The profile version.
" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The profile name.
" + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "The profile description.
" + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestions", + "traits": { + "smithy.api#documentation": "Profile questions.
" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "ShareInvitationId": { + "target": "com.amazonaws.wellarchitected#ShareInvitationId", + "traits": { + "smithy.api#documentation": "The ID assigned to the share invitation.
" + } + }, + "Tags": { + "target": "com.amazonaws.wellarchitected#TagMap", + "traits": { + "smithy.api#documentation": "The tags assigned to the profile.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A profile.
" + } + }, + "com.amazonaws.wellarchitected#ProfileArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2084 + }, + "smithy.api#pattern": "^arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileArns": { "type": "list", "member": { - "target": "com.amazonaws.wellarchitected#MilestoneSummary" + "target": "com.amazonaws.wellarchitected#ProfileArn" }, "traits": { - "smithy.api#documentation": "A list of milestone summaries.
" + "smithy.api#length": { + "min": 1 + } } }, - "com.amazonaws.wellarchitected#MilestoneSummary": { + "com.amazonaws.wellarchitected#ProfileChoice": { "type": "structure", "members": { - "MilestoneNumber": { - "target": "com.amazonaws.wellarchitected#MilestoneNumber", - "traits": { - "smithy.api#default": 0 - } - }, - "MilestoneName": { - "target": "com.amazonaws.wellarchitected#MilestoneName" + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" }, - "RecordedAt": { - "target": "com.amazonaws.wellarchitected#Timestamp" + "ChoiceTitle": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" }, - "WorkloadSummary": { - "target": "com.amazonaws.wellarchitected#WorkloadSummary" + "ChoiceDescription": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" } }, "traits": { - "smithy.api#documentation": "A milestone summary return object.
" + "smithy.api#documentation": "The profile choice.
" } }, - "com.amazonaws.wellarchitected#NextToken": { + "com.amazonaws.wellarchitected#ProfileDescription": { "type": "string", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next set of results.
" + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" } }, - "com.amazonaws.wellarchitected#Notes": { + "com.amazonaws.wellarchitected#ProfileName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" + } + }, + "com.amazonaws.wellarchitected#ProfileNamePrefix": { "type": "string", "traits": { - "smithy.api#documentation": "The notes associated with the workload.
", "smithy.api#length": { "min": 0, - "max": 2084 - } + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" } }, - "com.amazonaws.wellarchitected#NotificationSummaries": { + "com.amazonaws.wellarchitected#ProfileNotificationSummaries": { "type": "list", "member": { - "target": "com.amazonaws.wellarchitected#NotificationSummary" + "target": "com.amazonaws.wellarchitected#ProfileNotificationSummary" } }, - "com.amazonaws.wellarchitected#NotificationSummary": { + "com.amazonaws.wellarchitected#ProfileNotificationSummary": { "type": "structure", "members": { + "CurrentProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The current profile version.
" + } + }, + "LatestProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The latest profile version.
" + } + }, "Type": { - "target": "com.amazonaws.wellarchitected#NotificationType", + "target": "com.amazonaws.wellarchitected#ProfileNotificationType", "traits": { - "smithy.api#documentation": "The type of notification.
" + "smithy.api#documentation": "Type of notification.
" } }, - "LensUpgradeSummary": { - "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { - "smithy.api#documentation": "Summary of lens upgrade.
" + "smithy.api#documentation": "The profile ARN.
" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The profile name.
" } + }, + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId" + }, + "WorkloadName": { + "target": "com.amazonaws.wellarchitected#WorkloadName" } }, "traits": { - "smithy.api#documentation": "A notification summary return object.
" + "smithy.api#documentation": "The profile notification summary.
" } }, - "com.amazonaws.wellarchitected#NotificationType": { + "com.amazonaws.wellarchitected#ProfileNotificationType": { "type": "enum", "members": { - "LENS_VERSION_UPGRADED": { + "PROFILE_ANSWERS_UPDATED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LENS_VERSION_UPGRADED" + "smithy.api#enumValue": "PROFILE_ANSWERS_UPDATED" } }, - "LENS_VERSION_DEPRECATED": { + "PROFILE_DELETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "LENS_VERSION_DEPRECATED" + "smithy.api#enumValue": "PROFILE_DELETED" } } } }, - "com.amazonaws.wellarchitected#OrganizationSharingStatus": { + "com.amazonaws.wellarchitected#ProfileOwnerType": { "type": "enum", "members": { - "ENABLED": { + "SELF": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ENABLED" + "smithy.api#enumValue": "SELF" } }, - "DISABLED": { + "SHARED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DISABLED" + "smithy.api#enumValue": "SHARED" } } } }, - "com.amazonaws.wellarchitected#PermissionType": { - "type": "enum", + "com.amazonaws.wellarchitected#ProfileQuestion": { + "type": "structure", "members": { - "READONLY": { - "target": "smithy.api#Unit", + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" + }, + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" + }, + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" + }, + "QuestionChoices": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionChoices", "traits": { - "smithy.api#enumValue": "READONLY" + "smithy.api#documentation": "The question choices.
" } }, - "CONTRIBUTOR": { - "target": "smithy.api#Unit", + "SelectedChoiceIds": { + "target": "com.amazonaws.wellarchitected#SelectedChoiceIds", "traits": { - "smithy.api#enumValue": "CONTRIBUTOR" + "smithy.api#documentation": "The selected choices.
" + } + }, + "MinSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The minimum number of selected choices.
" + } + }, + "MaxSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of selected choices.
" } } }, "traits": { - "smithy.api#documentation": "Permission granted on a workload share.
" + "smithy.api#documentation": "A profile question.
" } }, - "com.amazonaws.wellarchitected#PillarDifference": { + "com.amazonaws.wellarchitected#ProfileQuestionChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileChoice" + } + }, + "com.amazonaws.wellarchitected#ProfileQuestionUpdate": { "type": "structure", "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "PillarName": { - "target": "com.amazonaws.wellarchitected#PillarName" - }, - "DifferenceStatus": { - "target": "com.amazonaws.wellarchitected#DifferenceStatus", - "traits": { - "smithy.api#documentation": "Indicates the type of change to the pillar.
" - } + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" }, - "QuestionDifferences": { - "target": "com.amazonaws.wellarchitected#QuestionDifferences", + "SelectedChoiceIds": { + "target": "com.amazonaws.wellarchitected#SelectedProfileChoiceIds", "traits": { - "smithy.api#documentation": "List of question differences.
" + "smithy.api#documentation": "The selected choices.
" } } }, "traits": { - "smithy.api#documentation": "A pillar difference return object.
" + "smithy.api#documentation": "An update to a profile question.
" } }, - "com.amazonaws.wellarchitected#PillarDifferences": { + "com.amazonaws.wellarchitected#ProfileQuestionUpdates": { "type": "list", "member": { - "target": "com.amazonaws.wellarchitected#PillarDifference" + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdate" } }, - "com.amazonaws.wellarchitected#PillarId": { - "type": "string", - "traits": { - "smithy.api#documentation": "The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
", - "smithy.api#length": { - "min": 1, - "max": 64 - } + "com.amazonaws.wellarchitected#ProfileQuestions": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileQuestion" } }, - "com.amazonaws.wellarchitected#PillarMetric": { + "com.amazonaws.wellarchitected#ProfileShareSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileShareSummary" + } + }, + "com.amazonaws.wellarchitected#ProfileShareSummary": { "type": "structure", "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" + "ShareId": { + "target": "com.amazonaws.wellarchitected#ShareId" }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" + "SharedWith": { + "target": "com.amazonaws.wellarchitected#SharedWith" }, - "Questions": { - "target": "com.amazonaws.wellarchitected#QuestionMetrics", + "Status": { + "target": "com.amazonaws.wellarchitected#ShareStatus" + }, + "StatusMessage": { + "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { - "smithy.api#documentation": "The questions that have been identified as risks in the pillar.
" + "smithy.api#documentation": "Profile share invitation status message.
" } } }, "traits": { - "smithy.api#documentation": "A metric for a particular pillar in a lens.
" + "smithy.api#documentation": "Summary of a profile share.
" } }, - "com.amazonaws.wellarchitected#PillarMetrics": { + "com.amazonaws.wellarchitected#ProfileSummaries": { "type": "list", "member": { - "target": "com.amazonaws.wellarchitected#PillarMetric" + "target": "com.amazonaws.wellarchitected#ProfileSummary" } }, - "com.amazonaws.wellarchitected#PillarName": { - "type": "string", - "traits": { - "smithy.api#documentation": "The name of the pillar.
", - "smithy.api#length": { - "min": 1, - "max": 128 + "com.amazonaws.wellarchitected#ProfileSummary": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The profile version.
" + } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The profile name.
" + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "The profile description.
" + } + }, + "Owner": { + "target": "com.amazonaws.wellarchitected#AwsAccountId" + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" } + }, + "traits": { + "smithy.api#documentation": "Summary of a profile.
" } }, - "com.amazonaws.wellarchitected#PillarNotes": { - "type": "map", - "key": { - "target": "com.amazonaws.wellarchitected#PillarId" - }, - "value": { - "target": "com.amazonaws.wellarchitected#Notes" + "com.amazonaws.wellarchitected#ProfileTemplate": { + "type": "structure", + "members": { + "TemplateName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The name of the profile template.
" + } + }, + "TemplateQuestions": { + "target": "com.amazonaws.wellarchitected#TemplateQuestions", + "traits": { + "smithy.api#documentation": "Profile template questions.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + }, + "UpdatedAt": { + "target": "com.amazonaws.wellarchitected#Timestamp" + } }, "traits": { - "smithy.api#documentation": "List of pillar notes of a lens review in a workload.
" + "smithy.api#documentation": "The profile template.
" } }, - "com.amazonaws.wellarchitected#PillarReviewSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.wellarchitected#PillarReviewSummary" + "com.amazonaws.wellarchitected#ProfileTemplateChoice": { + "type": "structure", + "members": { + "ChoiceId": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + }, + "ChoiceTitle": { + "target": "com.amazonaws.wellarchitected#ChoiceTitle" + }, + "ChoiceDescription": { + "target": "com.amazonaws.wellarchitected#ChoiceDescription" + } }, "traits": { - "smithy.api#documentation": "List of pillar review summaries of lens review in a workload.
" + "smithy.api#documentation": "A profile template choice.
" } }, - "com.amazonaws.wellarchitected#PillarReviewSummary": { + "com.amazonaws.wellarchitected#ProfileTemplateQuestion": { "type": "structure", "members": { - "PillarId": { - "target": "com.amazonaws.wellarchitected#PillarId" + "QuestionId": { + "target": "com.amazonaws.wellarchitected#QuestionId" }, - "PillarName": { - "target": "com.amazonaws.wellarchitected#PillarName" + "QuestionTitle": { + "target": "com.amazonaws.wellarchitected#QuestionTitle" }, - "Notes": { - "target": "com.amazonaws.wellarchitected#Notes" + "QuestionDescription": { + "target": "com.amazonaws.wellarchitected#QuestionDescription" }, - "RiskCounts": { - "target": "com.amazonaws.wellarchitected#RiskCounts" + "QuestionChoices": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices", + "traits": { + "smithy.api#documentation": "The question choices.
" + } + }, + "MinSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The minimum number of choices selected.
" + } + }, + "MaxSelectedChoices": { + "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of choices selected.
" + } } }, "traits": { - "smithy.api#documentation": "A pillar review summary of a lens review.
" + "smithy.api#documentation": "A profile template question.
" + } + }, + "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileTemplateChoice" + } + }, + "com.amazonaws.wellarchitected#ProfileVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, "com.amazonaws.wellarchitected#QuestionDescription": { @@ -5019,6 +6395,23 @@ "target": "com.amazonaws.wellarchitected#QuestionMetric" } }, + "com.amazonaws.wellarchitected#QuestionPriority": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZED" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.wellarchitected#QuestionTitle": { "type": "string", "traits": { @@ -5029,6 +6422,23 @@ } } }, + "com.amazonaws.wellarchitected#QuestionType": { + "type": "enum", + "members": { + "PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIORITIZED" + } + }, + "NON_PRIORITIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_PRIORITIZED" + } + } + } + }, "com.amazonaws.wellarchitected#QuotaCode": { "type": "string", "traits": { @@ -5130,6 +6540,12 @@ "smithy.api#documentation": "A map from risk names to the count of how many questions have that rating.
" } }, + "com.amazonaws.wellarchitected#SelectedChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } + }, "com.amazonaws.wellarchitected#SelectedChoices": { "type": "list", "member": { @@ -5139,6 +6555,12 @@ "smithy.api#documentation": "List of selected choice IDs in a question answer.
\nThe values entered replace the previously selected choices.
" } }, + "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ChoiceId" + } + }, "com.amazonaws.wellarchitected#ServiceCode": { "type": "string", "traits": { @@ -5182,7 +6604,7 @@ "com.amazonaws.wellarchitected#ShareId": { "type": "string", "traits": { - "smithy.api#documentation": "The ID associated with the workload share.
", + "smithy.api#documentation": "The ID associated with the share.
", "smithy.api#pattern": "^[0-9a-f]{32}$" } }, @@ -5212,6 +6634,12 @@ "traits": { "smithy.api#documentation": "The ARN for the lens.
" } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } } }, "traits": { @@ -5288,6 +6716,18 @@ "traits": { "smithy.api#documentation": "The ARN for the lens.
" } + }, + "ProfileName": { + "target": "com.amazonaws.wellarchitected#ProfileName", + "traits": { + "smithy.api#documentation": "The profile name.
" + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } } }, "traits": { @@ -5308,6 +6748,12 @@ "traits": { "smithy.api#enumValue": "LENS" } + }, + "PROFILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROFILE" + } } } }, @@ -5364,13 +6810,13 @@ } }, "traits": { - "smithy.api#documentation": "The status of a workload share.
" + "smithy.api#documentation": "The status of the share request.
" } }, "com.amazonaws.wellarchitected#SharedWith": { "type": "string", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
", + "smithy.api#documentation": "The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
", "smithy.api#length": { "min": 12, "max": 2048 @@ -5448,7 +6894,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds one or more tags to the specified resource.
\nThe WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
\nAdds one or more tags to the specified resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nDeletes specified tags from a resource.
\nThe WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
\nTo specify multiple tags, use separate tagKeys parameters, for example:
\n\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n
Deletes specified tags from a resource.
\nThe WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
\nTo specify multiple tags, use separate tagKeys parameters, for example:
\n\n DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2\n
Update a profile.
", + "smithy.api#http": { + "method": "PATCH", + "uri": "/profiles/{ProfileArn}", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpdateProfileInput": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileDescription": { + "target": "com.amazonaws.wellarchitected#ProfileDescription", + "traits": { + "smithy.api#documentation": "The profile description.
" + } + }, + "ProfileQuestions": { + "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", + "traits": { + "smithy.api#documentation": "Profile questions.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.wellarchitected#UpdateProfileOutput": { + "type": "structure", + "members": { + "Profile": { + "target": "com.amazonaws.wellarchitected#Profile", + "traits": { + "smithy.api#documentation": "The profile.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.wellarchitected#UpdateShareInvitation": { "type": "operation", "input": { @@ -6190,6 +7721,75 @@ "smithy.api#input": {} } }, + "com.amazonaws.wellarchitected#UpgradeProfileVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.wellarchitected#UpgradeProfileVersionInput" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.wellarchitected#AccessDeniedException" + }, + { + "target": "com.amazonaws.wellarchitected#ConflictException" + }, + { + "target": "com.amazonaws.wellarchitected#InternalServerException" + }, + { + "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.wellarchitected#ThrottlingException" + }, + { + "target": "com.amazonaws.wellarchitected#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Upgrade a profile.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade", + "code": 200 + } + } + }, + "com.amazonaws.wellarchitected#UpgradeProfileVersionInput": { + "type": "structure", + "members": { + "WorkloadId": { + "target": "com.amazonaws.wellarchitected#WorkloadId", + "traits": { + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MilestoneName": { + "target": "com.amazonaws.wellarchitected#MilestoneName" + }, + "ClientRequestToken": { + "target": "com.amazonaws.wellarchitected#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.wellarchitected#Urls": { "type": "list", "member": { @@ -6306,6 +7906,9 @@ { "target": "com.amazonaws.wellarchitected#AssociateLenses" }, + { + "target": "com.amazonaws.wellarchitected#AssociateProfiles" + }, { "target": "com.amazonaws.wellarchitected#CreateLensShare" }, @@ -6315,6 +7918,12 @@ { "target": "com.amazonaws.wellarchitected#CreateMilestone" }, + { + "target": "com.amazonaws.wellarchitected#CreateProfile" + }, + { + "target": "com.amazonaws.wellarchitected#CreateProfileShare" + }, { "target": "com.amazonaws.wellarchitected#CreateWorkload" }, @@ -6327,6 +7936,12 @@ { "target": "com.amazonaws.wellarchitected#DeleteLensShare" }, + { + "target": "com.amazonaws.wellarchitected#DeleteProfile" + }, + { + "target": "com.amazonaws.wellarchitected#DeleteProfileShare" + }, { "target": "com.amazonaws.wellarchitected#DeleteWorkload" }, @@ -6336,6 +7951,9 @@ { "target": "com.amazonaws.wellarchitected#DisassociateLenses" }, + { + "target": "com.amazonaws.wellarchitected#DisassociateProfiles" + }, { "target": "com.amazonaws.wellarchitected#ExportLens" }, @@ -6360,6 +7978,12 @@ { "target": "com.amazonaws.wellarchitected#GetMilestone" }, + { + "target": "com.amazonaws.wellarchitected#GetProfile" + }, + { + "target": "com.amazonaws.wellarchitected#GetProfileTemplate" + }, { "target": "com.amazonaws.wellarchitected#GetWorkload" }, @@ -6393,6 +8017,15 @@ { "target": "com.amazonaws.wellarchitected#ListNotifications" }, + { + "target": "com.amazonaws.wellarchitected#ListProfileNotifications" + }, + { + "target": "com.amazonaws.wellarchitected#ListProfiles" + }, + { + "target": "com.amazonaws.wellarchitected#ListProfileShares" + }, { "target": "com.amazonaws.wellarchitected#ListShareInvitations" }, @@ -6420,6 +8053,9 @@ { "target": "com.amazonaws.wellarchitected#UpdateLensReview" }, + { + "target": "com.amazonaws.wellarchitected#UpdateProfile" + }, { "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" }, @@ -6431,6 +8067,9 @@ }, { "target": "com.amazonaws.wellarchitected#UpgradeLensReview" + }, + { + "target": "com.amazonaws.wellarchitected#UpgradeProfileVersion" } ], "traits": { @@ -7427,6 +9066,15 @@ "traits": { "smithy.api#documentation": "List of AppRegistry application ARNs associated to the workload.
" } + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "Profile associated with a workload.
" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { @@ -7542,6 +9190,10 @@ "type": "string", "traits": { "smithy.api#documentation": "The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
", + "smithy.api#length": { + "min": 32, + "max": 32 + }, "smithy.api#pattern": "^[0-9a-f]{32}$" } }, @@ -7663,6 +9315,50 @@ "smithy.api#documentation": "The priorities of the pillars, which are used to order items in the improvement plan.\n Each pillar is represented by its PillarReviewSummary$PillarId.
" } }, + "com.amazonaws.wellarchitected#WorkloadProfile": { + "type": "structure", + "members": { + "ProfileArn": { + "target": "com.amazonaws.wellarchitected#ProfileArn", + "traits": { + "smithy.api#documentation": "The profile ARN.
" + } + }, + "ProfileVersion": { + "target": "com.amazonaws.wellarchitected#ProfileVersion", + "traits": { + "smithy.api#documentation": "The profile version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The profile associated with a workload.
" + } + }, + "com.amazonaws.wellarchitected#WorkloadProfileArns": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#ProfileArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.wellarchitected#WorkloadProfiles": { + "type": "list", + "member": { + "target": "com.amazonaws.wellarchitected#WorkloadProfile" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.wellarchitected#WorkloadResourceDefinition": { "type": "list", "member": { @@ -7778,6 +9474,15 @@ }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" + }, + "Profiles": { + "target": "com.amazonaws.wellarchitected#WorkloadProfiles", + "traits": { + "smithy.api#documentation": "Profile associated with a workload.
" + } + }, + "PrioritizedRiskCounts": { + "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { diff --git a/sdk.properties b/sdk.properties index be5af62ff19..117789faa8b 100644 --- a/sdk.properties +++ b/sdk.properties @@ -1 +1 @@ -# No excluded models +excludeModels=verifiedpermissions.2021-12-01